all: autogenerated update (2017-08-25)
Update:
- appengine/v1
- appengine/v1beta
- cloudbuild/v1
- cloudfunctions/v1beta2
- container/v1beta1
- dataproc/v1
- dataproc/v1beta2
- genomics/v1
- genomics/v1alpha2
- logging/v2
- logging/v2beta1
- people/v1
diff --git a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
index 9093d7c..3f4040f 100644
--- a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
+++ b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
@@ -2,98 +2,43 @@
"name": "acceleratedmobilepageurl",
"batchPath": "batch",
"revision": "20170718",
- "documentationLink": "https://developers.google.com/amp/cache/",
"id": "acceleratedmobilepageurl:v1",
+ "documentationLink": "https://developers.google.com/amp/cache/",
"title": "Accelerated Mobile Pages (AMP) URL API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": "True",
"resources": {
"ampUrls": {
"methods": {
"batchGet": {
- "parameters": {},
- "flatPath": "v1/ampUrls:batchGet",
- "id": "acceleratedmobilepageurl.ampUrls.batchGet",
- "path": "v1/ampUrls:batchGet",
- "request": {
- "$ref": "BatchGetAmpUrlsRequest"
- },
- "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "BatchGetAmpUrlsResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST"
+ "parameters": {},
+ "flatPath": "v1/ampUrls:batchGet",
+ "path": "v1/ampUrls:batchGet",
+ "id": "acceleratedmobilepageurl.ampUrls.batchGet",
+ "request": {
+ "$ref": "BatchGetAmpUrlsRequest"
+ },
+ "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format)."
}
}
}
},
"parameters": {
- "$.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": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -106,20 +51,95 @@
"type": "boolean",
"location": "query"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "fields": {
+ "uploadType": {
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
}
},
"schemas": {
+ "BatchGetAmpUrlsResponse": {
+ "description": "Batch AMP URL response.",
+ "type": "object",
+ "properties": {
+ "urlErrors": {
+ "description": "The errors for requested URLs that have no AMP URL.",
+ "items": {
+ "$ref": "AmpUrlError"
+ },
+ "type": "array"
+ },
+ "ampUrls": {
+ "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.",
+ "items": {
+ "$ref": "AmpUrl"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchGetAmpUrlsResponse"
+ },
"AmpUrl": {
- "id": "AmpUrl",
"description": "AMP URL response for a requested URL.",
"type": "object",
"properties": {
@@ -135,7 +155,8 @@
"description": "The original non-AMP URL.",
"type": "string"
}
- }
+ },
+ "id": "AmpUrl"
},
"AmpUrlError": {
"id": "AmpUrlError",
@@ -176,6 +197,13 @@
"description": "AMP URL request for a batch of URLs.",
"type": "object",
"properties": {
+ "urls": {
+ "description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"lookupStrategy": {
"description": "The lookup_strategy being requested.",
"type": "string",
@@ -187,49 +215,21 @@
"FETCH_LIVE_DOC",
"IN_INDEX_DOC"
]
- },
- "urls": {
- "description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).",
- "items": {
- "type": "string"
- },
- "type": "array"
}
},
"id": "BatchGetAmpUrlsRequest"
- },
- "BatchGetAmpUrlsResponse": {
- "id": "BatchGetAmpUrlsResponse",
- "description": "Batch AMP URL response.",
- "type": "object",
- "properties": {
- "urlErrors": {
- "description": "The errors for requested URLs that have no AMP URL.",
- "items": {
- "$ref": "AmpUrlError"
- },
- "type": "array"
- },
- "ampUrls": {
- "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.",
- "items": {
- "$ref": "AmpUrl"
- },
- "type": "array"
- }
- }
}
},
"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://acceleratedmobilepageurl.googleapis.com/",
- "servicePath": "",
- "description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
"kind": "discovery#restDescription",
+ "description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
+ "servicePath": "",
"rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com"
diff --git a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
index 7f61604..3a52f63 100644
--- a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
+++ b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
@@ -1,4 +1,10 @@
{
+ "rootUrl": "https://adexchangebuyer.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "adexchangebuyer2",
+ "batchPath": "batch",
+ "title": "Ad Exchange Buyer API II",
+ "ownerName": "Google",
"resources": {
"accounts": {
"resources": {
@@ -19,17 +25,17 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"accountId": {
- "type": "string",
- "required": true,
"location": "path",
"format": "int64",
- "description": "Unique numerical account ID of the sponsor buyer to list the clients for."
+ "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
@@ -41,65 +47,20 @@
"description": "Lists all the clients for the current sponsor buyer."
},
"get": {
- "description": "Gets a client buyer with a given client account ID.",
- "response": {
- "$ref": "Client"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
- "clientAccountId": {
- "format": "int64",
- "description": "Numerical account ID of the client buyer to retrieve. (required)",
- "type": "string",
- "required": true,
- "location": "path"
- },
"accountId": {
- "location": "path",
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.get",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}"
- },
- "update": {
- "request": {
- "$ref": "Client"
- },
- "description": "Updates an existing client buyer.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "response": {
- "$ref": "Client"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "format": "int64",
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
- "type": "string",
"required": true,
"location": "path"
},
"clientAccountId": {
"format": "int64",
- "description": "Unique numerical account ID of the client to update. (required)",
+ "description": "Numerical account ID of the client buyer to retrieve. (required)",
"type": "string",
"required": true,
"location": "path"
@@ -107,13 +68,54 @@
},
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.update"
+ "id": "adexchangebuyer2.accounts.clients.get",
+ "description": "Gets a client buyer with a given client account ID.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "response": {
+ "$ref": "Client"
+ }
},
- "create": {
- "description": "Creates a new client buyer.",
+ "update": {
+ "response": {
+ "$ref": "Client"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "clientAccountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Unique numerical account ID of the client to update. (required)",
+ "type": "string",
+ "required": true
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "id": "adexchangebuyer2.accounts.clients.update",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"request": {
"$ref": "Client"
},
+ "description": "Updates an existing client buyer."
+ },
+ "create": {
"response": {
"$ref": "Client"
},
@@ -121,163 +123,35 @@
"accountId"
],
"httpMethod": "POST",
- "parameters": {
- "accountId": {
- "format": "int64",
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
+ "type": "string",
+ "required": true
+ }
+ },
"flatPath": "v2beta1/accounts/{accountId}/clients",
"id": "adexchangebuyer2.accounts.clients.create",
- "path": "v2beta1/accounts/{accountId}/clients"
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "request": {
+ "$ref": "Client"
+ },
+ "description": "Creates a new client buyer."
}
},
"resources": {
- "users": {
- "methods": {
- "get": {
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.get",
- "description": "Retrieves an existing client user.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "response": {
- "$ref": "ClientUser"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "userId": {
- "location": "path",
- "format": "int64",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "type": "string",
- "required": true
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "type": "string",
- "required": true
- },
- "clientAccountId": {
- "format": "int64",
- "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
- "type": "string",
- "required": true,
- "location": "path"
- }
- }
- },
- "list": {
- "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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListClientUsersResponse"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "clientAccountId": {
- "location": "path",
- "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default."
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users"
- },
- "update": {
- "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
- "request": {
- "$ref": "ClientUser"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "response": {
- "$ref": "ClientUser"
- },
- "parameters": {
- "clientAccountId": {
- "location": "path",
- "format": "int64",
- "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
- "type": "string",
- "required": true
- },
- "userId": {
- "format": "int64",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "accountId": {
- "format": "int64",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.update"
- }
- }
- },
"invitations": {
"methods": {
"list": {
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.list",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "id": "adexchangebuyer2.accounts.clients.invitations.list",
"description": "Lists all the client users invitations for a client\nwith a given account ID.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListClientUserInvitationsResponse"
},
@@ -285,50 +159,48 @@
"accountId",
"clientAccountId"
],
- "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod."
- },
"pageSize": {
- "format": "int32",
- "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
"type": "integer",
- "location": "query"
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default."
},
"accountId": {
+ "type": "string",
+ "required": true,
"location": "path",
"format": "int64",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "type": "string",
- "required": true
+ "description": "Numerical account ID of the client's sponsor buyer. (required)"
},
"clientAccountId": {
- "location": "path",
"description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations"
},
"get": {
- "httpMethod": "GET",
+ "description": "Retrieves an existing client user invitation.",
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
"parameterOrder": [
"accountId",
"clientAccountId",
"invitationId"
],
- "response": {
- "$ref": "ClientUserInvitation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "httpMethod": "GET",
"parameters": {
"accountId": {
"format": "int64",
@@ -345,36 +217,79 @@
"description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)"
},
"invitationId": {
+ "location": "path",
"format": "int64",
"description": "Numerical identifier of the user invitation to retrieve. (required)",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"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."
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}"
},
"create": {
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.create",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "id": "adexchangebuyer2.accounts.clients.invitations.create",
"description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
"request": {
"$ref": "ClientUserInvitation"
},
- "response": {
- "$ref": "ClientUserInvitation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"accountId",
"clientAccountId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
"parameters": {
"accountId": {
+ "format": "int64",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "users": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "ClientUser"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "userId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "type": "string",
+ "required": true
+ },
+ "accountId": {
"location": "path",
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
@@ -382,16 +297,107 @@
"required": true
},
"clientAccountId": {
+ "location": "path",
"format": "int64",
- "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
+ "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "id": "adexchangebuyer2.accounts.clients.users.get",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "description": "Retrieves an existing client user."
+ },
+ "list": {
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "response": {
+ "$ref": "ListClientUsersResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
+ "type": "string",
+ "required": true
+ },
+ "clientAccountId": {
+ "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users"
+ },
+ "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"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "userId": {
+ "format": "int64",
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "accountId": {
+ "format": "int64",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "id": "adexchangebuyer2.accounts.clients.users.update"
}
}
}
@@ -401,65 +407,19 @@
"resources": {
"dealAssociations": {
"methods": {
- "list": {
- "description": "List all creative-deal associations.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "response": {
- "$ref": "ListDealAssociationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "location": "path",
- "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
- "type": "string",
- "required": true
- },
- "query": {
- "location": "query",
- "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
- "type": "string"
- },
- "creativeId": {
- "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list"
- },
"remove": {
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
+ "description": "Remove the association between a deal and a creative.",
+ "request": {
+ "$ref": "RemoveDealAssociationRequest"
+ },
"response": {
"$ref": "Empty"
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
],
+ "httpMethod": "POST",
"parameters": {
"accountId": {
"type": "string",
@@ -468,27 +428,20 @@
"description": "The account the creative belongs to."
},
"creativeId": {
- "location": "path",
"description": "The ID of the creative associated with the deal.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
"id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
- "request": {
- "$ref": "RemoveDealAssociationRequest"
- },
- "description": "Remove the association between a deal and a creative."
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove"
},
"add": {
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "request": {
- "$ref": "AddDealAssociationRequest"
- },
- "description": "Associate an existing deal with a creative.",
"response": {
"$ref": "Empty"
},
@@ -497,106 +450,91 @@
"creativeId"
],
"httpMethod": "POST",
+ "parameters": {
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "creativeId": {
+ "location": "path",
+ "description": "The ID of the creative associated with the deal.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "description": "Associate an existing deal with a creative.",
+ "request": {
+ "$ref": "AddDealAssociationRequest"
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListDealAssociationsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
- "accountId": {
- "location": "path",
- "description": "The account the creative belongs to.",
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
"type": "string",
- "required": true
+ "location": "query"
},
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "query": {
+ "description": "An optional query string to filter 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.",
+ "type": "string",
+ "required": true
}
},
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add"
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
+ "description": "List all creative-deal associations."
}
}
}
},
"methods": {
- "list": {
- "description": "Lists creatives.",
- "response": {
- "$ref": "ListCreativesResponse"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive."
- },
- "accountId": {
- "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "query": {
- "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from DisapprovalReason\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.list",
- "path": "v2beta1/accounts/{accountId}/creatives"
- },
- "create": {
- "request": {
- "$ref": "Creative"
- },
- "description": "Creates a creative.",
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "scopes": [
- "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": {
- "location": "path",
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.create"
- },
"stopWatching": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"accountId": {
"description": "The account of the creative to stop notifications for.",
@@ -605,44 +543,35 @@
"location": "path"
},
"creativeId": {
- "location": "path",
"description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
"id": "adexchangebuyer2.accounts.creatives.stopWatching",
+ "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "response": {
- "$ref": "Empty"
}
},
"get": {
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "id": "adexchangebuyer2.accounts.creatives.get",
"description": "Gets a creative.",
- "response": {
- "$ref": "Creative"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"accountId",
"creativeId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "response": {
+ "$ref": "Creative"
+ },
"parameters": {
"accountId": {
"description": "The account the creative belongs to.",
@@ -651,32 +580,21 @@
"location": "path"
},
"creativeId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The ID of the creative to retrieve."
+ "description": "The ID of the creative to retrieve.",
+ "type": "string",
+ "required": true
}
},
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.get",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}"
},
"watch": {
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "id": "adexchangebuyer2.accounts.creatives.watch",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
- "request": {
- "$ref": "WatchCreativeRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
],
- "httpMethod": "POST",
"parameters": {
"creativeId": {
"location": "path",
@@ -685,31 +603,123 @@
"required": true
},
"accountId": {
- "description": "The account of the creative to watch.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "The account of the creative to watch."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "update": {
- "httpMethod": "PUT",
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "id": "adexchangebuyer2.accounts.creatives.watch",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "request": {
+ "$ref": "WatchCreativeRequest"
+ },
+ "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
+ "response": {
+ "$ref": "Empty"
+ },
"parameterOrder": [
"accountId",
"creativeId"
],
+ "httpMethod": "POST"
+ },
+ "update": {
+ "response": {
+ "$ref": "Creative"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "creativeId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod."
+ },
+ "accountId": {
+ "location": "path",
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "id": "adexchangebuyer2.accounts.creatives.update",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "request": {
+ "$ref": "Creative"
+ },
+ "description": "Updates a creative."
+ },
+ "list": {
+ "description": "Lists creatives.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "response": {
+ "$ref": "ListCreativesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
+ "type": "integer"
+ },
+ "accountId": {
+ "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "query": {
+ "type": "string",
+ "location": "query",
+ "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from DisapprovalReason\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.list"
+ },
+ "create": {
+ "description": "Creates a creative.",
+ "request": {
+ "$ref": "Creative"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "accountId"
+ ],
"response": {
"$ref": "Creative"
},
"parameters": {
- "creativeId": {
- "location": "path",
- "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string",
- "required": true
+ "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"
},
"accountId": {
"description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
@@ -721,30 +731,60 @@
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.update",
- "description": "Updates a creative.",
- "request": {
- "$ref": "Creative"
- }
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.create"
}
}
},
"filterSets": {
"methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameters": {
+ "isTransient": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation."
+ },
+ "accountId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "format": "int64",
+ "description": "Account ID of the buyer."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets",
+ "path": "v2beta1/accounts/{accountId}/filterSets",
+ "id": "adexchangebuyer2.accounts.filterSets.create",
+ "description": "Creates the specified filter set for the account with the given account ID.",
+ "request": {
+ "$ref": "FilterSet"
+ }
+ },
"delete": {
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
+ "id": "adexchangebuyer2.accounts.filterSets.delete",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
+ "description": "Deletes the requested filter set from the account with the given account\nID.",
+ "response": {
+ "$ref": "Empty"
+ },
"parameterOrder": [
"accountId",
"filterSetId"
],
- "response": {
- "$ref": "Empty"
- },
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"accountId": {
"location": "path",
@@ -761,22 +801,18 @@
"required": true
}
},
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
- "id": "adexchangebuyer2.accounts.filterSets.delete",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
- "description": "Deletes the requested filter set from the account with the given account\nID."
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
"list": {
"httpMethod": "GET",
- "response": {
- "$ref": "ListFilterSetsResponse"
- },
"parameterOrder": [
"accountId"
],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "response": {
+ "$ref": "ListFilterSetsResponse"
+ },
"parameters": {
"pageToken": {
"location": "query",
@@ -784,19 +820,22 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"accountId": {
- "location": "path",
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/accounts/{accountId}/filterSets",
"path": "v2beta1/accounts/{accountId}/filterSets",
"id": "adexchangebuyer2.accounts.filterSets.list",
@@ -821,11 +860,11 @@
"required": true
},
"accountId": {
- "location": "path",
"format": "int64",
"description": "Account ID of the buyer.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"scopes": [
@@ -834,43 +873,104 @@
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
"id": "adexchangebuyer2.accounts.filterSets.get"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "FilterSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "isTransient": {
- "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
- "type": "boolean",
- "location": "query"
- },
- "accountId": {
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/filterSets",
- "path": "v2beta1/accounts/{accountId}/filterSets",
- "id": "adexchangebuyer2.accounts.filterSets.create",
- "request": {
- "$ref": "FilterSet"
- },
- "description": "Creates the specified filter set for the account with the given account ID."
}
},
"resources": {
+ "nonBillableWinningBids": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "response": {
+ "$ref": "ListNonBillableWinningBidsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod."
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
+ "id": "adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list",
+ "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason."
+ }
+ }
+ },
"filteredBids": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListFilteredBidsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.list\nmethod.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer",
+ "location": "query"
+ },
+ "accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "filterSetId": {
+ "location": "path",
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBids.list",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
+ "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason."
+ }
+ },
"resources": {
"creatives": {
"methods": {
@@ -888,13 +988,6 @@
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
- },
"pageToken": {
"location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod.",
@@ -919,6 +1012,13 @@
"description": "Account ID of the buyer.",
"type": "string",
"required": true
+ },
+ "filterSetId": {
+ "location": "path",
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true
}
},
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
@@ -931,26 +1031,24 @@
"details": {
"methods": {
"list": {
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
"path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
"id": "adexchangebuyer2.accounts.filterSets.filteredBids.details.list",
"description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
"httpMethod": "GET",
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByDetailResponse"
+ },
"parameterOrder": [
"accountId",
"filterSetId",
"creativeStatusId"
],
- "response": {
- "$ref": "ListCreativeStatusBreakdownByDetailResponse"
- },
- "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\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"creativeStatusId": {
"type": "integer",
@@ -973,135 +1071,54 @@
"required": true
},
"filterSetId": {
+ "type": "string",
+ "required": true,
"location": "path",
"format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
+ "description": "The ID of the filter set to apply."
}
},
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
}
}
- },
- "methods": {
- "list": {
- "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
- "response": {
- "$ref": "ListFilteredBidsResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
- "filterSetId": {
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
- "id": "adexchangebuyer2.accounts.filterSets.filteredBids.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids"
- }
- }
- },
- "nonBillableWinningBids": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListNonBillableWinningBidsResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
- "id": "adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list",
- "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason."
- }
}
},
"losingBids": {
"methods": {
"list": {
+ "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
+ "response": {
+ "$ref": "ListLosingBidsResponse"
+ },
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"filterSetId"
],
- "response": {
- "$ref": "ListLosingBidsResponse"
- },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"parameters": {
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true,
+ "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\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.losingBids.list\nmethod.",
- "type": "string"
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.losingBids.list\nmethod."
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"accountId": {
"location": "path",
@@ -1109,22 +1126,11 @@
"description": "Account ID of the buyer.",
"type": "string",
"required": true
- },
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids",
"id": "adexchangebuyer2.accounts.filterSets.losingBids.list",
- "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason."
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids"
}
}
},
@@ -1132,19 +1138,22 @@
"methods": {
"list": {
"description": "Lists all metrics that are measured in terms of number of impressions.",
- "response": {
- "$ref": "ListImpressionMetricsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"accountId",
"filterSetId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListImpressionMetricsResponse"
+ },
+ "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\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.impressionMetrics.list\nmethod.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"format": "int32",
@@ -1167,21 +1176,15 @@
"required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
- "id": "adexchangebuyer2.accounts.filterSets.impressionMetrics.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics"
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
+ "id": "adexchangebuyer2.accounts.filterSets.impressionMetrics.list"
}
}
},
"bidMetrics": {
"methods": {
"list": {
- "id": "adexchangebuyer2.accounts.filterSets.bidMetrics.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
- "description": "Lists all metrics that are measured in terms of number of bids.",
"response": {
"$ref": "ListBidMetricsResponse"
},
@@ -1191,6 +1194,19 @@
],
"httpMethod": "GET",
"parameters": {
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default."
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true
+ },
"filterSetId": {
"location": "path",
"format": "int64",
@@ -1199,34 +1215,32 @@
"required": true
},
"pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidMetrics.list\nmethod.",
"type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "accountId": {
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true,
- "location": "path"
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidMetrics.list\nmethod."
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics"
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
+ "id": "adexchangebuyer2.accounts.filterSets.bidMetrics.list",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
+ "description": "Lists all metrics that are measured in terms of number of bids."
}
}
},
"bidResponseErrors": {
"methods": {
"list": {
+ "response": {
+ "$ref": "ListBidResponseErrorsResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
@@ -1239,9 +1253,9 @@
"required": true
},
"pageToken": {
- "location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponseErrors.list\nmethod.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"type": "integer",
@@ -1250,102 +1264,94 @@
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default."
},
"accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
"type": "string",
"required": true,
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer."
+ "location": "path"
}
},
"flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
"id": "adexchangebuyer2.accounts.filterSets.bidResponseErrors.list",
- "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListBidResponseErrorsResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ]
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
+ "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason."
}
}
},
"bidResponsesWithoutBids": {
"methods": {
"list": {
- "id": "adexchangebuyer2.accounts.filterSets.bidResponsesWithoutBids.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
- "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
- "response": {
- "$ref": "ListBidResponsesWithoutBidsResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
],
- "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
"filterSetId": {
"location": "path",
"format": "int64",
"description": "The ID of the filter set to apply.",
"type": "string",
"required": true
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
+ "id": "adexchangebuyer2.accounts.filterSets.bidResponsesWithoutBids.list",
+ "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids"
+ "response": {
+ "$ref": "ListBidResponsesWithoutBidsResponse"
+ }
}
}
},
"filteredBidRequests": {
"methods": {
"list": {
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBidRequests.list",
"description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
- "response": {
- "$ref": "ListFilteredBidRequestsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"accountId",
"filterSetId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
"parameters": {
"pageToken": {
- "location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"accountId": {
"format": "int64",
@@ -1355,16 +1361,16 @@
"location": "path"
},
"filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
"type": "string",
"required": true,
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply."
+ "location": "path"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
- "id": "adexchangebuyer2.accounts.filterSets.filteredBidRequests.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
}
}
@@ -1374,59 +1380,27 @@
}
},
"parameters": {
- "quotaUser": {
- "type": "string",
+ "uploadType": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "oauth_token": {
- "type": "string",
- "location": "query",
- "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": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
]
},
"callback": {
@@ -1435,7 +1409,6 @@
"type": "string"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1448,1053 +1421,86 @@
"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"
+ },
+ "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": {
+ "default": "true",
+ "type": "boolean",
+ "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": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
}
},
"version": "v2beta1",
"baseUrl": "https://adexchangebuyer.googleapis.com/",
- "servicePath": "",
- "description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
"kind": "discovery#restDescription",
+ "description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
+ "servicePath": "",
"basePath": "",
+ "id": "adexchangebuyer2:v2beta1",
"revision": "20170815",
"documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
- "id": "adexchangebuyer2:v2beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "WatchCreativeRequest": {
- "description": "A request for watching changes to creative Status.",
- "type": "object",
- "properties": {
- "topic": {
- "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.",
- "type": "string"
- }
- },
- "id": "WatchCreativeRequest"
- },
- "TimeInterval": {
- "description": "An interval of time, with an absolute start and end.\nThis is included in the response, for several reasons:\n1) The request may have specified start or end times relative to the time the\n request was sent; the response indicates the corresponding absolute time\n interval.\n2) The request may have specified an end time past the latest time for which\n data was available (e.g. if requesting data for the today); the response\n indicates the latest time for which data was actually returned.\n3) The response data for a single request may be broken down into multiple\n time intervals, if a time series was requested.",
- "type": "object",
- "properties": {
- "startTime": {
- "format": "google-datetime",
- "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
- "type": "string"
- }
- },
- "id": "TimeInterval"
- },
- "FilteredBidCreativeRow": {
- "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
- "type": "object",
- "properties": {
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified creative."
- },
- "creativeId": {
- "description": "The ID of the creative.",
- "type": "string"
- }
- },
- "id": "FilteredBidCreativeRow"
- },
- "RelativeDateRange": {
- "properties": {
- "offsetDays": {
- "format": "int32",
- "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
- "type": "integer"
- },
- "durationDays": {
- "format": "int32",
- "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
- "type": "integer"
- }
- },
- "id": "RelativeDateRange",
- "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days \u003e= 0\nduration_days \u003e= 1\noffset_days + duration_days \u003c= 30",
- "type": "object"
- },
- "NativeContent": {
- "id": "NativeContent",
- "description": "Native content for a creative.",
- "type": "object",
- "properties": {
- "videoUrl": {
- "description": "The URL to fetch a native video ad.",
- "type": "string"
- },
- "logo": {
- "description": "A smaller image, for the advertiser's logo.",
- "$ref": "Image"
- },
- "clickLinkUrl": {
- "description": "The URL that the browser/SDK will load when the user clicks the ad.",
- "type": "string"
- },
- "priceDisplayText": {
- "description": "The price of the promoted app including currency info.",
- "type": "string"
- },
- "image": {
- "description": "A large image.",
- "$ref": "Image"
- },
- "clickTrackingUrl": {
- "description": "The URL to use for click tracking.",
- "type": "string"
- },
- "advertiserName": {
- "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
- "type": "string"
- },
- "storeUrl": {
- "description": "The URL to the app store to purchase/download the promoted app.",
- "type": "string"
- },
- "headline": {
- "description": "A short title for the ad.",
- "type": "string"
- },
- "appIcon": {
- "description": "The app icon, for app download ads.",
- "$ref": "Image"
- },
- "callToAction": {
- "description": "A label for the button that the user is supposed to click.",
- "type": "string"
- },
- "body": {
- "description": "A long description of the ad.",
- "type": "string"
- },
- "starRating": {
- "type": "number",
- "format": "double",
- "description": "The app rating in the app store. Must be in the range [0-5]."
- }
- }
- },
- "ListClientsResponse": {
- "type": "object",
- "properties": {
- "clients": {
- "description": "The returned list of clients.",
- "items": {
- "$ref": "Client"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListClientsResponse"
- },
- "ListBidResponsesWithoutBidsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "bidResponseWithoutBidsStatusRows": {
- "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
- "items": {
- "$ref": "BidResponseWithoutBidsStatusRow"
- },
- "type": "array"
- }
- },
- "id": "ListBidResponsesWithoutBidsResponse",
- "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
- "type": "object"
- },
- "ServingContext": {
- "description": "The serving context for this restriction.",
- "type": "object",
- "properties": {
- "platform": {
- "$ref": "PlatformContext",
- "description": "Matches impressions coming from a particular platform."
- },
- "location": {
- "description": "Matches impressions coming from users *or* publishers in a specific\nlocation.",
- "$ref": "LocationContext"
- },
- "auctionType": {
- "description": "Matches impressions for a particular auction type.",
- "$ref": "AuctionContext"
- },
- "all": {
- "enumDescriptions": [
- "A simple context."
- ],
- "enum": [
- "SIMPLE_CONTEXT"
- ],
- "description": "Matches all contexts.",
- "type": "string"
- },
- "appType": {
- "description": "Matches impressions for a particular app type.",
- "$ref": "AppContext"
- },
- "securityType": {
- "description": "Matches impressions for a particular security type.",
- "$ref": "SecurityContext"
- }
- },
- "id": "ServingContext"
- },
- "Image": {
- "type": "object",
- "properties": {
- "width": {
- "format": "int32",
- "description": "Image width in pixels.",
- "type": "integer"
- },
- "url": {
- "description": "The URL of the image.",
- "type": "string"
- },
- "height": {
- "format": "int32",
- "description": "Image height in pixels.",
- "type": "integer"
- }
- },
- "id": "Image",
- "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved."
- },
- "ListFilterSetsResponse": {
- "properties": {
- "filterSets": {
- "description": "The filter sets belonging to the buyer.",
- "items": {
- "$ref": "FilterSet"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListFilterSetsResponse",
- "description": "Response message for listing filter sets.",
- "type": "object"
- },
- "BidResponseWithoutBidsStatusRow": {
- "properties": {
- "impressionCount": {
- "description": "The number of impressions for which there was a bid response with the\nspecified status.",
- "$ref": "MetricValue"
- },
- "status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "RESPONSES_WITHOUT_BIDS",
- "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
- "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
- ],
- "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "The response had no bids.",
- "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
- "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
- ]
- },
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- }
- },
- "id": "BidResponseWithoutBidsStatusRow",
- "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
- "type": "object"
- },
- "ClientUserInvitation": {
- "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
- "type": "object",
- "properties": {
- "clientAccountId": {
- "format": "int64",
- "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
- "type": "string"
- },
- "invitationId": {
- "format": "int64",
- "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
- "type": "string"
- },
- "email": {
- "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
- "type": "string"
- }
- },
- "id": "ClientUserInvitation"
- },
- "ListClientUserInvitationsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
- "type": "string"
- },
- "invitations": {
- "description": "The returned list of client users.",
- "items": {
- "$ref": "ClientUserInvitation"
- },
- "type": "array"
- }
- },
- "id": "ListClientUserInvitationsResponse",
- "type": "object"
- },
- "ListClientUsersResponse": {
- "id": "ListClientUsersResponse",
- "type": "object",
- "properties": {
- "users": {
- "description": "The returned list of client users.",
- "items": {
- "$ref": "ClientUser"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
- "type": "string"
- }
- }
- },
- "ListCreativeStatusBreakdownByDetailResponse": {
- "description": "Response message for listing all details associated with a given filtered bid\nreason.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "filteredBidDetailRows": {
- "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
- "items": {
- "$ref": "FilteredBidDetailRow"
- },
- "type": "array"
- },
- "detailType": {
- "description": "The type of detail that the detail IDs represent.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
- "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
- "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
- "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).",
- "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
- ],
- "enum": [
- "DETAIL_TYPE_UNSPECIFIED",
- "CREATIVE_ATTRIBUTE",
- "VENDOR",
- "SENSITIVE_CATEGORY",
- "PRODUCT_CATEGORY",
- "DISAPPROVAL_REASON"
- ]
- }
- },
- "id": "ListCreativeStatusBreakdownByDetailResponse"
- },
- "LocationContext": {
- "id": "LocationContext",
- "description": "@OutputOnly The Geo criteria the restriction applies to.",
- "type": "object",
- "properties": {
- "geoCriteriaIds": {
- "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- }
- }
- },
- "PlatformContext": {
- "description": "@OutputOnly The type of platform the restriction applies to.",
- "type": "object",
- "properties": {
- "platforms": {
- "enumDescriptions": [
- "Desktop platform.",
- "Android platform.",
- "iOS platform."
- ],
- "description": "The platforms this restriction applies to.",
- "items": {
- "type": "string",
- "enum": [
- "DESKTOP",
- "ANDROID",
- "IOS"
- ]
- },
- "type": "array"
- }
- },
- "id": "PlatformContext"
- },
- "MetricValue": {
- "type": "object",
- "properties": {
- "variance": {
- "format": "int64",
- "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value",
- "type": "string"
- },
- "value": {
- "format": "int64",
- "description": "The expected value of the metric.",
- "type": "string"
- }
- },
- "id": "MetricValue",
- "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled)."
- },
- "ClientUser": {
- "type": "object",
- "properties": {
- "clientAccountId": {
- "format": "int64",
- "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
- "type": "string"
- },
- "status": {
- "enum": [
- "USER_STATUS_UNSPECIFIED",
- "PENDING",
- "ACTIVE",
- "DISABLED"
- ],
- "description": "The status of the client user.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined user status.",
- "A user who was already created but hasn't accepted the invitation yet.",
- "A user that is currently active.",
- "A user that is currently disabled."
- ]
- },
- "email": {
- "description": "User's email address. The value of this field\nis ignored in an update operation.",
- "type": "string"
- },
- "userId": {
- "type": "string",
- "format": "int64",
- "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation."
- }
- },
- "id": "ClientUser",
- "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified."
- },
- "CreativeDealAssociation": {
- "description": "The association between a creative and a deal.",
- "type": "object",
- "properties": {
- "accountId": {
- "description": "The account the creative belongs to.",
- "type": "string"
- },
- "creativeId": {
- "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"
- },
- "FilteringStats": {
- "id": "FilteringStats",
- "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
- "type": "object",
- "properties": {
- "reasons": {
- "description": "The set of filtering reasons for this date.",
- "items": {
- "$ref": "Reason"
- },
- "type": "array"
- },
- "date": {
- "$ref": "Date",
- "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24."
- }
- }
- },
- "Creative": {
- "description": "A creative and its classification data.",
- "type": "object",
- "properties": {
- "filteringStats": {
- "$ref": "FilteringStats",
- "description": "@OutputOnly The filtering stats for this creative."
- },
- "attributes": {
- "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "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"
- },
- "type": "array",
- "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": {
- "format": "google-datetime",
- "description": "@OutputOnly The last update timestamp of the creative via API.",
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "creativeId": {
- "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string"
- },
- "accountId": {
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string"
- },
- "native": {
- "$ref": "NativeContent",
- "description": "A native creative."
- },
- "servingRestrictions": {
- "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
- "items": {
- "$ref": "ServingRestriction"
- },
- "type": "array"
- },
- "video": {
- "description": "A video creative.",
- "$ref": "VideoContent"
- },
- "agencyId": {
- "format": "int64",
- "description": "The agency ID for this creative.",
- "type": "string"
- },
- "clickThroughUrls": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The set of destination URLs for the creative."
- },
- "detectedSensitiveCategories": {
- "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "adChoicesDestinationUrl": {
- "description": "The link to AdChoices destination page.",
- "type": "string"
- },
- "restrictedCategories": {
- "description": "All restricted categories for the ads that may be shown from this creative.",
- "items": {
- "enum": [
- "NO_RESTRICTED_CATEGORIES",
- "ALCOHOL"
- ],
- "type": "string"
- },
- "type": "array",
- "enumDescriptions": [
- "The ad has no restricted categories",
- "The alcohol restricted category."
- ]
- },
- "corrections": {
- "description": "@OutputOnly Shows any corrections that were applied to this creative.",
- "items": {
- "$ref": "Correction"
- },
- "type": "array"
- },
- "version": {
- "format": "int32",
- "description": "@OutputOnly The version of this creative.",
- "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.",
- "items": {
- "type": "integer",
- "format": "int32"
- },
- "type": "array"
- },
- "impressionTrackingUrls": {
- "description": "The set of URLs to be called to record an impression.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "html": {
- "description": "An HTML creative.",
- "$ref": "HtmlContent"
- },
- "detectedProductCategories": {
- "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "dealsStatus": {
- "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string",
- "enumDescriptions": [
- "The status is unknown.",
- "The creative has not been checked.",
- "The creative has been conditionally approved.\nSee serving_restrictions for details.",
- "The creative has been approved.",
- "The creative has been disapproved."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "NOT_CHECKED",
- "CONDITIONALLY_APPROVED",
- "APPROVED",
- "DISAPPROVED"
- ]
- },
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "detectedAdvertiserIds": {
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array",
- "description": "@OutputOnly Detected advertiser IDs, if any."
- }
- },
- "id": "Creative"
- },
- "RemoveDealAssociationRequest": {
- "description": "A request for removing the association between a deal and a creative.",
- "type": "object",
- "properties": {
- "association": {
- "$ref": "CreativeDealAssociation",
- "description": "The association between a creative and a deal that should be removed."
- }
- },
- "id": "RemoveDealAssociationRequest"
- },
- "Client": {
- "description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
- "type": "object",
- "properties": {
- "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": {
- "format": "int64",
- "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
- "type": "string"
- },
- "clientAccountId": {
- "format": "int64",
- "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
- "type": "string"
- },
- "entityName": {
- "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "A placeholder for an undefined client status.",
- "A client that is currently disabled.",
- "A client that is currently active."
- ],
- "enum": [
- "CLIENT_STATUS_UNSPECIFIED",
- "DISABLED",
- "ACTIVE"
- ],
- "description": "The status of the client buyer.",
- "type": "string"
- },
- "entityType": {
- "enum": [
- "ENTITY_TYPE_UNSPECIFIED",
- "ADVERTISER",
- "BRAND",
- "AGENCY"
- ],
- "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined client entity type. Should not be used.",
- "An advertiser.",
- "A brand.",
- "An advertising agency."
- ]
- },
- "clientName": {
- "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
- "type": "string"
- }
- },
- "id": "Client"
- },
- "ListCreativeStatusBreakdownByCreativeResponse": {
- "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
- "type": "object",
- "properties": {
- "filteredBidCreativeRows": {
- "items": {
- "$ref": "FilteredBidCreativeRow"
- },
- "type": "array",
- "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative."
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListCreativeStatusBreakdownByCreativeResponse"
- },
- "Correction": {
- "properties": {
- "type": {
- "description": "The type of correction that was applied to the creative.",
- "type": "string",
- "enumDescriptions": [
- "The correction type is unknown. Refer to the details for more information.",
- "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.",
- "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.",
- "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.",
- "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.",
- "The ad did not declare a required creative attribute.\nThe attribute was added.",
- "The ad did not declare a required technology vendor.\nThe technology vendor was added.",
- "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.",
- "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.",
- "The ad makes calls to the MRAID API so the MRAID attribute was added.",
- "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.",
- "The ad contains video content."
- ],
- "enum": [
- "CORRECTION_TYPE_UNSPECIFIED",
- "VENDOR_IDS_ADDED",
- "SSL_ATTRIBUTE_REMOVED",
- "FLASH_FREE_ATTRIBUTE_REMOVED",
- "FLASH_FREE_ATTRIBUTE_ADDED",
- "REQUIRED_ATTRIBUTE_ADDED",
- "REQUIRED_VENDOR_ADDED",
- "SSL_ATTRIBUTE_ADDED",
- "IN_BANNER_VIDEO_ATTRIBUTE_ADDED",
- "MRAID_ATTRIBUTE_ADDED",
- "FLASH_ATTRIBUTE_REMOVED",
- "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
- ]
- },
- "contexts": {
- "description": "The contexts for the correction.",
- "items": {
- "$ref": "ServingContext"
- },
- "type": "array"
- },
- "details": {
- "description": "Additional details about what was corrected.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "Correction",
- "description": "@OutputOnly Shows any corrections that were applied to this creative.",
- "type": "object"
- },
- "FilterSet": {
- "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"",
- "type": "object",
- "properties": {
- "sellerNetworkIds": {
- "description": "The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "ownerAccountId": {
- "format": "int64",
- "description": "The account ID of the buyer who owns this filter set.\nThe value of this field is ignored in create operations.",
- "type": "string"
- },
- "buyerAccountId": {
- "format": "int64",
- "description": "The ID of the buyer account on which to filter; optional.",
- "type": "string"
- },
- "absoluteDateRange": {
- "$ref": "AbsoluteDateRange",
- "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
- },
- "environment": {
- "description": "The environment on which to filter; optional.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
- "The ad impression appears on the web.",
- "The ad impression appears in an app."
- ],
- "enum": [
- "ENVIRONMENT_UNSPECIFIED",
- "WEB",
- "APP"
- ]
- },
- "dealId": {
- "format": "int64",
- "description": "The ID of the deal on which to filter; optional.",
- "type": "string"
- },
- "format": {
- "enumDescriptions": [
- "A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
- "The ad impression is display format (i.e. an image).",
- "The ad impression is video format."
- ],
- "enum": [
- "FORMAT_UNSPECIFIED",
- "DISPLAY",
- "VIDEO"
- ],
- "description": "The format on which to filter; optional.",
- "type": "string"
- },
- "timeSeriesGranularity": {
- "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.",
- "Indicates that data will be broken down by the hour.",
- "Indicates that data will be broken down by the day."
- ],
- "enum": [
- "TIME_SERIES_GRANULARITY_UNSPECIFIED",
- "HOURLY",
- "DAILY"
- ]
- },
- "filterSetId": {
- "format": "int64",
- "description": "The ID of the filter set; unique within the account of the filter set\nowner.\nThe value of this field is ignored in create operations.",
- "type": "string"
- },
- "realtimeTimeRange": {
- "$ref": "RealtimeTimeRange",
- "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp."
- },
- "creativeId": {
- "description": "The ID of the creative on which to filter; optional.",
- "type": "string"
- },
- "platforms": {
- "items": {
- "enum": [
- "PLATFORM_UNSPECIFIED",
- "DESKTOP",
- "TABLET",
- "MOBILE"
- ],
- "type": "string"
- },
- "type": "array",
- "enumDescriptions": [
- "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
- "The ad impression appears on a desktop.",
- "The ad impression appears on a tablet.",
- "The ad impression appears on a mobile device."
- ],
- "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms)."
- },
- "relativeDateRange": {
- "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone.",
- "$ref": "RelativeDateRange"
- }
- },
- "id": "FilterSet"
- },
"ListDealAssociationsResponse": {
"description": "A response for listing creative and deal associations",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
- "type": "string"
- },
"associations": {
"description": "The list of associations.",
"items": {
"$ref": "CreativeDealAssociation"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
+ "type": "string"
}
},
"id": "ListDealAssociationsResponse"
},
"CalloutStatusRow": {
+ "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.",
"type": "object",
"properties": {
- "calloutStatusId": {
- "type": "integer",
- "format": "int32",
- "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes)."
- },
"impressionCount": {
"$ref": "MetricValue",
"description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
@@ -2502,12 +1508,17 @@
"rowDimensions": {
"$ref": "RowDimensions",
"description": "The values of all dimensions associated with metric values in this row."
+ },
+ "calloutStatusId": {
+ "format": "int32",
+ "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
+ "type": "integer"
}
},
- "id": "CalloutStatusRow",
- "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status."
+ "id": "CalloutStatusRow"
},
"Disapproval": {
+ "description": "@OutputOnly The reason and details for a disapproval.",
"type": "object",
"properties": {
"details": {
@@ -2518,8 +1529,6 @@
"type": "array"
},
"reason": {
- "description": "The categorized reason for disapproval.",
- "type": "string",
"enumDescriptions": [
"The length of the image animation is longer than allowed.",
"The click through URL doesn't work properly.",
@@ -2711,37 +1720,23 @@
"MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
"PERSONAL_LOANS",
"UNSUPPORTED_FLASH_CONTENT"
- ]
+ ],
+ "description": "The categorized reason for disapproval.",
+ "type": "string"
}
},
- "id": "Disapproval",
- "description": "@OutputOnly The reason and details for a disapproval."
+ "id": "Disapproval"
},
"StopWatchingCreativeRequest": {
+ "description": "A request for stopping notifications for changes to creative Status.",
"type": "object",
"properties": {},
- "id": "StopWatchingCreativeRequest",
- "description": "A request for stopping notifications for changes to creative Status."
+ "id": "StopWatchingCreativeRequest"
},
"ServingRestriction": {
- "id": "ServingRestriction",
"description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
"type": "object",
"properties": {
- "disapprovalReasons": {
- "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "items": {
- "$ref": "Disapproval"
- },
- "type": "array"
- },
- "contexts": {
- "description": "The contexts for the restriction.",
- "items": {
- "$ref": "ServingContext"
- },
- "type": "array"
- },
"status": {
"enum": [
"STATUS_UNSPECIFIED",
@@ -2755,8 +1750,23 @@
"The ad was disapproved in this context.",
"The ad is pending review in this context."
]
+ },
+ "disapprovalReasons": {
+ "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "items": {
+ "$ref": "Disapproval"
+ },
+ "type": "array"
+ },
+ "contexts": {
+ "description": "The contexts for the restriction.",
+ "items": {
+ "$ref": "ServingContext"
+ },
+ "type": "array"
}
- }
+ },
+ "id": "ServingRestriction"
},
"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`.",
@@ -2781,7 +1791,6 @@
"id": "Date"
},
"RowDimensions": {
- "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
"type": "object",
"properties": {
"timeInterval": {
@@ -2789,24 +1798,20 @@
"description": "The time interval that this row represents."
}
},
- "id": "RowDimensions"
+ "id": "RowDimensions",
+ "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row."
},
"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",
+ "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 `{}`."
},
"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.",
"items": {
"enum": [
"NATIVE",
@@ -2814,7 +1819,12 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "enumDescriptions": [
+ "Native app context.",
+ "Mobile web app context."
+ ],
+ "description": "The app types this restriction applies to."
}
},
"id": "AppContext"
@@ -2831,8 +1841,8 @@
"type": "array"
},
"nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.list\nmethod to retrieve the next page of results."
}
},
"id": "ListFilteredBidsResponse"
@@ -2860,14 +1870,8 @@
"description": "@OutputOnly A security context."
},
"HtmlContent": {
- "description": "HTML content for a creative.",
"type": "object",
"properties": {
- "width": {
- "format": "int32",
- "description": "The width of the HTML snippet in pixels.",
- "type": "integer"
- },
"snippet": {
"description": "The HTML snippet that displays the ad when inserted in the web page.",
"type": "string"
@@ -2876,29 +1880,37 @@
"format": "int32",
"description": "The height of the HTML snippet in pixels.",
"type": "integer"
+ },
+ "width": {
+ "format": "int32",
+ "description": "The width of the HTML snippet in pixels.",
+ "type": "integer"
}
},
- "id": "HtmlContent"
+ "id": "HtmlContent",
+ "description": "HTML content for a creative."
},
"ListCreativesResponse": {
- "description": "A response for listing creatives.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
"type": "string"
},
"creatives": {
- "description": "The list of creatives.",
"items": {
"$ref": "Creative"
},
- "type": "array"
+ "type": "array",
+ "description": "The list of creatives."
}
},
- "id": "ListCreativesResponse"
+ "id": "ListCreativesResponse",
+ "description": "A response for listing creatives.",
+ "type": "object"
},
"ListFilteredBidRequestsResponse": {
+ "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
+ "type": "object",
"properties": {
"calloutStatusRows": {
"description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
@@ -2912,9 +1924,7 @@
"type": "string"
}
},
- "id": "ListFilteredBidRequestsResponse",
- "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
- "type": "object"
+ "id": "ListFilteredBidRequestsResponse"
},
"ListBidMetricsResponse": {
"description": "Response message for listing the metrics that are measured in number of bids.",
@@ -2925,11 +1935,11 @@
"type": "string"
},
"bidMetricsRows": {
+ "description": "List of rows, each containing a set of bid metrics.",
"items": {
"$ref": "BidMetricsRow"
},
- "type": "array",
- "description": "List of rows, each containing a set of bid metrics."
+ "type": "array"
}
},
"id": "ListBidMetricsResponse"
@@ -2952,6 +1962,7 @@
"id": "Reason"
},
"VideoContent": {
+ "description": "Video content for a creative.",
"type": "object",
"properties": {
"videoUrl": {
@@ -2959,10 +1970,10 @@
"type": "string"
}
},
- "id": "VideoContent",
- "description": "Video content for a creative."
+ "id": "VideoContent"
},
"ListLosingBidsResponse": {
+ "id": "ListLosingBidsResponse",
"description": "Response message for listing all reasons that bids lost in the auction.",
"type": "object",
"properties": {
@@ -2974,14 +1985,12 @@
"type": "array"
},
"nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the next page of results."
}
- },
- "id": "ListLosingBidsResponse"
+ }
},
"ListNonBillableWinningBidsResponse": {
- "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -2996,47 +2005,45 @@
"type": "array"
}
},
- "id": "ListNonBillableWinningBidsResponse"
+ "id": "ListNonBillableWinningBidsResponse",
+ "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid."
},
"ImpressionMetricsRow": {
"description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.",
"type": "object",
"properties": {
- "responsesWithBids": {
- "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid.",
- "$ref": "MetricValue"
- },
- "successfulResponses": {
- "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange.",
- "$ref": "MetricValue"
- },
"rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
},
"availableImpressions": {
- "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable.",
+ "$ref": "MetricValue",
+ "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable."
+ },
+ "bidRequests": {
+ "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest.",
"$ref": "MetricValue"
},
"inventoryMatches": {
"$ref": "MetricValue",
"description": "The number of impressions that match the buyer's inventory pretargeting."
},
- "bidRequests": {
+ "responsesWithBids": {
"$ref": "MetricValue",
- "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
+ "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
+ },
+ "successfulResponses": {
+ "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange.",
+ "$ref": "MetricValue"
}
},
"id": "ImpressionMetricsRow"
},
"AuctionContext": {
+ "description": "@OutputOnly The auction type the restriction applies to.",
+ "type": "object",
"properties": {
"auctionTypes": {
- "enumDescriptions": [
- "The restriction applies to open auction.",
- "The restriction applies to direct deals."
- ],
- "description": "The auction types this restriction applies to.",
"items": {
"enum": [
"OPEN_AUCTION",
@@ -3044,53 +2051,41 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "enumDescriptions": [
+ "The restriction applies to open auction.",
+ "The restriction applies to direct deals."
+ ],
+ "description": "The auction types this restriction applies to."
}
},
- "id": "AuctionContext",
- "description": "@OutputOnly The auction type the restriction applies to.",
- "type": "object"
+ "id": "AuctionContext"
},
"ListImpressionMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
+ "type": "object",
"properties": {
- "impressionMetricsRows": {
- "items": {
- "$ref": "ImpressionMetricsRow"
- },
- "type": "array",
- "description": "List of rows, each containing a set of impression metrics."
- },
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to retrieve the next page of results.",
"type": "string"
+ },
+ "impressionMetricsRows": {
+ "description": "List of rows, each containing a set of impression metrics.",
+ "items": {
+ "$ref": "ImpressionMetricsRow"
+ },
+ "type": "array"
}
},
- "id": "ListImpressionMetricsResponse",
- "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
- "type": "object"
+ "id": "ListImpressionMetricsResponse"
},
"BidMetricsRow": {
+ "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
"type": "object",
"properties": {
- "viewableImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
- },
- "impressionsWon": {
- "$ref": "MetricValue",
- "description": "The number of bids that won an impression."
- },
- "measurableImpressions": {
- "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View).",
- "$ref": "MetricValue"
- },
- "bids": {
- "$ref": "MetricValue",
- "description": "The number of bids that Ad Exchange received from the buyer."
- },
"billedImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the buyer was billed."
+ "description": "The number of bids for which the buyer was billed.",
+ "$ref": "MetricValue"
},
"bidsInAuction": {
"$ref": "MetricValue",
@@ -3099,10 +2094,25 @@
"rowDimensions": {
"description": "The values of all dimensions associated with metric values in this row.",
"$ref": "RowDimensions"
+ },
+ "viewableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
+ },
+ "impressionsWon": {
+ "description": "The number of bids that won an impression.",
+ "$ref": "MetricValue"
+ },
+ "measurableImpressions": {
+ "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View).",
+ "$ref": "MetricValue"
+ },
+ "bids": {
+ "description": "The number of bids that Ad Exchange received from the buyer.",
+ "$ref": "MetricValue"
}
},
- "id": "BidMetricsRow",
- "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;"
+ "id": "BidMetricsRow"
},
"ListBidResponseErrorsResponse": {
"description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
@@ -3123,6 +2133,8 @@
"id": "ListBidResponseErrorsResponse"
},
"CreativeStatusRow": {
+ "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
+ "type": "object",
"properties": {
"rowDimensions": {
"$ref": "RowDimensions",
@@ -3138,11 +2150,11 @@
"description": "The number of bids with the specified status."
}
},
- "id": "CreativeStatusRow",
- "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
- "type": "object"
+ "id": "CreativeStatusRow"
},
"RealtimeTimeRange": {
+ "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
+ "type": "object",
"properties": {
"startTimestamp": {
"format": "google-datetime",
@@ -3150,46 +2162,42 @@
"type": "string"
}
},
- "id": "RealtimeTimeRange",
- "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
- "type": "object"
+ "id": "RealtimeTimeRange"
},
"NonBillableWinningBidStatusRow": {
- "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
- "type": "object",
"properties": {
+ "bidCount": {
+ "description": "The number of bids with the specified status.",
+ "$ref": "MetricValue"
+ },
"status": {
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "The buyer was not billed because the ad was not rendered by the\npublisher.",
+ "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
+ ],
"enum": [
"STATUS_UNSPECIFIED",
"AD_NOT_RENDERED",
"INVALID_IMPRESSION"
],
"description": "The status specifying why the winning bids were not billed.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "The buyer was not billed because the ad was not rendered by the\npublisher.",
- "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
- ]
+ "type": "string"
},
"rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified status."
- }
- },
- "id": "NonBillableWinningBidStatusRow"
- },
- "FilteredBidDetailRow": {
- "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
- "type": "object",
- "properties": {
- "rowDimensions": {
"description": "The values of all dimensions associated with metric values in this row.",
"$ref": "RowDimensions"
+ }
+ },
+ "id": "NonBillableWinningBidStatusRow",
+ "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
+ "type": "object"
+ },
+ "FilteredBidDetailRow": {
+ "properties": {
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
},
"detailId": {
"format": "int32",
@@ -3197,44 +2205,1042 @@
"type": "integer"
},
"bidCount": {
- "description": "The number of bids with the specified detail.",
- "$ref": "MetricValue"
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified detail."
}
},
- "id": "FilteredBidDetailRow"
+ "id": "FilteredBidDetailRow",
+ "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
+ "type": "object"
},
"AbsoluteDateRange": {
"description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
"type": "object",
"properties": {
"endDate": {
- "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date.",
- "$ref": "Date"
+ "$ref": "Date",
+ "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date."
},
"startDate": {
- "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date.",
- "$ref": "Date"
+ "$ref": "Date",
+ "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date."
}
},
"id": "AbsoluteDateRange"
},
"AddDealAssociationRequest": {
+ "description": "A request for associating a deal and a creative.",
+ "type": "object",
"properties": {
"association": {
"$ref": "CreativeDealAssociation",
"description": "The association between a creative and a deal that should be added."
}
},
- "id": "AddDealAssociationRequest",
- "description": "A request for associating a deal and a creative.",
+ "id": "AddDealAssociationRequest"
+ },
+ "WatchCreativeRequest": {
+ "description": "A request for watching changes to creative Status.",
+ "type": "object",
+ "properties": {
+ "topic": {
+ "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.",
+ "type": "string"
+ }
+ },
+ "id": "WatchCreativeRequest"
+ },
+ "TimeInterval": {
+ "description": "An interval of time, with an absolute start and end.\nThis is included in the response, for several reasons:\n1) The request may have specified start or end times relative to the time the\n request was sent; the response indicates the corresponding absolute time\n interval.\n2) The request may have specified an end time past the latest time for which\n data was available (e.g. if requesting data for the today); the response\n indicates the latest time for which data was actually returned.\n3) The response data for a single request may be broken down into multiple\n time intervals, if a time series was requested.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded."
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
+ "type": "string"
+ }
+ },
+ "id": "TimeInterval"
+ },
+ "FilteredBidCreativeRow": {
+ "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
+ "type": "object",
+ "properties": {
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified creative."
+ },
+ "creativeId": {
+ "type": "string",
+ "description": "The ID of the creative."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ }
+ },
+ "id": "FilteredBidCreativeRow"
+ },
+ "RelativeDateRange": {
+ "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days \u003e= 0\nduration_days \u003e= 1\noffset_days + duration_days \u003c= 30",
+ "type": "object",
+ "properties": {
+ "durationDays": {
+ "format": "int32",
+ "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
+ "type": "integer"
+ },
+ "offsetDays": {
+ "format": "int32",
+ "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
+ "type": "integer"
+ }
+ },
+ "id": "RelativeDateRange"
+ },
+ "NativeContent": {
+ "description": "Native content for a creative.",
+ "type": "object",
+ "properties": {
+ "callToAction": {
+ "description": "A label for the button that the user is supposed to click.",
+ "type": "string"
+ },
+ "body": {
+ "description": "A long description of the ad.",
+ "type": "string"
+ },
+ "starRating": {
+ "format": "double",
+ "description": "The app rating in the app store. Must be in the range [0-5].",
+ "type": "number"
+ },
+ "videoUrl": {
+ "description": "The URL to fetch a native video ad.",
+ "type": "string"
+ },
+ "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"
+ },
+ "image": {
+ "$ref": "Image",
+ "description": "A large image."
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "advertiserName": {
+ "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
+ "type": "string"
+ },
+ "storeUrl": {
+ "description": "The URL to the app store to purchase/download the promoted app.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "A short title for the ad.",
+ "type": "string"
+ },
+ "appIcon": {
+ "$ref": "Image",
+ "description": "The app icon, for app download ads."
+ }
+ },
+ "id": "NativeContent"
+ },
+ "ListClientsResponse": {
+ "id": "ListClientsResponse",
+ "type": "object",
+ "properties": {
+ "clients": {
+ "description": "The returned list of clients.",
+ "items": {
+ "$ref": "Client"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
+ "type": "string"
+ }
+ }
+ },
+ "ListBidResponsesWithoutBidsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
+ "bidResponseWithoutBidsStatusRows": {
+ "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
+ "items": {
+ "$ref": "BidResponseWithoutBidsStatusRow"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListBidResponsesWithoutBidsResponse",
+ "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
"type": "object"
+ },
+ "ServingContext": {
+ "description": "The serving context for this restriction.",
+ "type": "object",
+ "properties": {
+ "securityType": {
+ "description": "Matches impressions for a particular security type.",
+ "$ref": "SecurityContext"
+ },
+ "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": {
+ "$ref": "AuctionContext",
+ "description": "Matches impressions for a particular auction type."
+ },
+ "all": {
+ "enum": [
+ "SIMPLE_CONTEXT"
+ ],
+ "description": "Matches all contexts.",
+ "type": "string",
+ "enumDescriptions": [
+ "A simple context."
+ ]
+ },
+ "appType": {
+ "$ref": "AppContext",
+ "description": "Matches impressions for a particular app type."
+ }
+ },
+ "id": "ServingContext"
+ },
+ "Image": {
+ "id": "Image",
+ "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
+ "type": "object",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "description": "Image height in pixels.",
+ "type": "integer"
+ },
+ "width": {
+ "format": "int32",
+ "description": "Image width in pixels.",
+ "type": "integer"
+ },
+ "url": {
+ "description": "The URL of the image.",
+ "type": "string"
+ }
+ }
+ },
+ "ListFilterSetsResponse": {
+ "type": "object",
+ "properties": {
+ "filterSets": {
+ "description": "The filter sets belonging to the buyer.",
+ "items": {
+ "$ref": "FilterSet"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results."
+ }
+ },
+ "id": "ListFilterSetsResponse",
+ "description": "Response message for listing filter sets."
+ },
+ "BidResponseWithoutBidsStatusRow": {
+ "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
+ "type": "object",
+ "properties": {
+ "impressionCount": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which there was a bid response with the\nspecified status."
+ },
+ "status": {
+ "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "The response had no bids.",
+ "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
+ "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "RESPONSES_WITHOUT_BIDS",
+ "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
+ "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
+ ]
+ },
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ }
+ },
+ "id": "BidResponseWithoutBidsStatusRow"
+ },
+ "ClientUserInvitation": {
+ "id": "ClientUserInvitation",
+ "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
+ "type": "object",
+ "properties": {
+ "invitationId": {
+ "format": "int64",
+ "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
+ "type": "string"
+ },
+ "email": {
+ "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
+ "type": "string"
+ },
+ "clientAccountId": {
+ "format": "int64",
+ "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
+ "type": "string"
+ }
+ }
+ },
+ "ListClientUserInvitationsResponse": {
+ "type": "object",
+ "properties": {
+ "invitations": {
+ "description": "The returned list of client users.",
+ "items": {
+ "$ref": "ClientUserInvitation"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results."
+ }
+ },
+ "id": "ListClientUserInvitationsResponse"
+ },
+ "ListClientUsersResponse": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "description": "The returned list of client users.",
+ "items": {
+ "$ref": "ClientUser"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results."
+ }
+ },
+ "id": "ListClientUsersResponse"
+ },
+ "ListCreativeStatusBreakdownByDetailResponse": {
+ "description": "Response message for listing all details associated with a given filtered bid\nreason.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
+ "filteredBidDetailRows": {
+ "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
+ "items": {
+ "$ref": "FilteredBidDetailRow"
+ },
+ "type": "array"
+ },
+ "detailType": {
+ "enum": [
+ "DETAIL_TYPE_UNSPECIFIED",
+ "CREATIVE_ATTRIBUTE",
+ "VENDOR",
+ "SENSITIVE_CATEGORY",
+ "PRODUCT_CATEGORY",
+ "DISAPPROVAL_REASON"
+ ],
+ "description": "The type of detail that the detail IDs represent.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
+ "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
+ "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
+ "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).",
+ "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
+ ]
+ }
+ },
+ "id": "ListCreativeStatusBreakdownByDetailResponse"
+ },
+ "LocationContext": {
+ "description": "@OutputOnly The Geo criteria the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "geoCriteriaIds": {
+ "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "id": "LocationContext"
+ },
+ "PlatformContext": {
+ "description": "@OutputOnly The type of platform the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "platforms": {
+ "description": "The platforms this restriction applies to.",
+ "items": {
+ "enum": [
+ "DESKTOP",
+ "ANDROID",
+ "IOS"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Desktop platform.",
+ "Android platform.",
+ "iOS platform."
+ ]
+ }
+ },
+ "id": "PlatformContext"
+ },
+ "MetricValue": {
+ "properties": {
+ "variance": {
+ "type": "string",
+ "format": "int64",
+ "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value"
+ },
+ "value": {
+ "format": "int64",
+ "description": "The expected value of the metric.",
+ "type": "string"
+ }
+ },
+ "id": "MetricValue",
+ "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).",
+ "type": "object"
+ },
+ "ClientUser": {
+ "properties": {
+ "clientAccountId": {
+ "format": "int64",
+ "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "USER_STATUS_UNSPECIFIED",
+ "PENDING",
+ "ACTIVE",
+ "DISABLED"
+ ],
+ "description": "The status of the client user.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined user status.",
+ "A user who was already created but hasn't accepted the invitation yet.",
+ "A user that is currently active.",
+ "A user that is currently disabled."
+ ]
+ },
+ "email": {
+ "description": "User's email address. The value of this field\nis ignored in an update operation.",
+ "type": "string"
+ },
+ "userId": {
+ "format": "int64",
+ "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
+ "type": "string"
+ }
+ },
+ "id": "ClientUser",
+ "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
+ "type": "object"
+ },
+ "CreativeDealAssociation": {
+ "description": "The association between a creative and a deal.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "type": "string"
+ }
+ },
+ "id": "CreativeDealAssociation"
+ },
+ "Creative": {
+ "id": "Creative",
+ "description": "A creative and its classification data.",
+ "type": "object",
+ "properties": {
+ "filteringStats": {
+ "$ref": "FilteringStats",
+ "description": "@OutputOnly The filtering stats for this creative."
+ },
+ "attributes": {
+ "enumDescriptions": [
+ "Do not use. This is a placeholder value only.",
+ "The creative is tagged.",
+ "The creative is cookie targeted.",
+ "The creative is user interest targeted.",
+ "The creative does not expand.",
+ "The creative expands up.",
+ "The creative expands down.",
+ "The creative expands left.",
+ "The creative expands right.",
+ "The creative expands up and left.",
+ "The creative expands up and right.",
+ "The creative expands down and left.",
+ "The creative expands down and right.",
+ "The creative expands up or down.",
+ "The creative expands left or right.",
+ "The creative expands on any diagonal.",
+ "The creative expands when rolled over.",
+ "The instream vast video type is vpaid flash.",
+ "The creative is MRAID",
+ "The creative is SSL.",
+ "The creative is an interstitial.",
+ "The creative is eligible for native.",
+ "The creative is not eligible for native.",
+ "The creative can dynamically resize to fill a variety of slot sizes."
+ ],
+ "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "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"
+ ]
+ },
+ "type": "array"
+ },
+ "apiUpdateTime": {
+ "format": "google-datetime",
+ "description": "@OutputOnly The last update timestamp of the creative via API.",
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "creativeId": {
+ "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string"
+ },
+ "accountId": {
+ "type": "string",
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod."
+ },
+ "native": {
+ "$ref": "NativeContent",
+ "description": "A native creative."
+ },
+ "servingRestrictions": {
+ "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
+ "items": {
+ "$ref": "ServingRestriction"
+ },
+ "type": "array"
+ },
+ "video": {
+ "$ref": "VideoContent",
+ "description": "A video creative."
+ },
+ "agencyId": {
+ "format": "int64",
+ "description": "The agency ID for this creative.",
+ "type": "string"
+ },
+ "clickThroughUrls": {
+ "description": "The set of destination URLs for the creative.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "adChoicesDestinationUrl": {
+ "description": "The link to AdChoices destination page.",
+ "type": "string"
+ },
+ "detectedSensitiveCategories": {
+ "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "restrictedCategories": {
+ "description": "All restricted categories for the ads that may be shown from this creative.",
+ "items": {
+ "enum": [
+ "NO_RESTRICTED_CATEGORIES",
+ "ALCOHOL"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "The ad has no restricted categories",
+ "The alcohol restricted category."
+ ]
+ },
+ "corrections": {
+ "items": {
+ "$ref": "Correction"
+ },
+ "type": "array",
+ "description": "@OutputOnly Shows any corrections that were applied to this creative."
+ },
+ "version": {
+ "format": "int32",
+ "description": "@OutputOnly The version of this creative.",
+ "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.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "impressionTrackingUrls": {
+ "description": "The set of URLs to be called to record an impression.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "html": {
+ "$ref": "HtmlContent",
+ "description": "An HTML creative."
+ },
+ "dealsStatus": {
+ "enumDescriptions": [
+ "The status is unknown.",
+ "The creative has not been checked.",
+ "The creative has been conditionally approved.\nSee serving_restrictions for details.",
+ "The creative has been approved.",
+ "The creative has been disapproved."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "NOT_CHECKED",
+ "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.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "openAuctionStatus": {
+ "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string",
+ "enumDescriptions": [
+ "The status is unknown.",
+ "The creative has not been checked.",
+ "The creative has been conditionally approved.\nSee serving_restrictions for details.",
+ "The creative has been approved.",
+ "The creative has been disapproved."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "NOT_CHECKED",
+ "CONDITIONALLY_APPROVED",
+ "APPROVED",
+ "DISAPPROVED"
+ ]
+ },
+ "advertiserName": {
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "detectedAdvertiserIds": {
+ "description": "@OutputOnly Detected advertiser IDs, if any.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "detectedDomains": {
+ "description": "@OutputOnly\nThe detected domains for this creative.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "FilteringStats": {
+ "id": "FilteringStats",
+ "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
+ "type": "object",
+ "properties": {
+ "date": {
+ "$ref": "Date",
+ "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24."
+ },
+ "reasons": {
+ "items": {
+ "$ref": "Reason"
+ },
+ "type": "array",
+ "description": "The set of filtering reasons for this date."
+ }
+ }
+ },
+ "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 removed.",
+ "$ref": "CreativeDealAssociation"
+ }
+ },
+ "id": "RemoveDealAssociationRequest"
+ },
+ "ListCreativeStatusBreakdownByCreativeResponse": {
+ "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
+ "type": "object",
+ "properties": {
+ "filteredBidCreativeRows": {
+ "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
+ "items": {
+ "$ref": "FilteredBidCreativeRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListCreativeStatusBreakdownByCreativeResponse"
+ },
+ "Client": {
+ "description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
+ "type": "object",
+ "properties": {
+ "entityType": {
+ "enumDescriptions": [
+ "A placeholder for an undefined client entity type. Should not be used.",
+ "An advertiser.",
+ "A brand.",
+ "An advertising agency."
+ ],
+ "enum": [
+ "ENTITY_TYPE_UNSPECIFIED",
+ "ADVERTISER",
+ "BRAND",
+ "AGENCY"
+ ],
+ "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
+ "type": "string"
+ },
+ "clientName": {
+ "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
+ "type": "string"
+ },
+ "role": {
+ "enumDescriptions": [
+ "A placeholder for an undefined client role.",
+ "Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.",
+ "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
+ "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
+ ],
+ "enum": [
+ "CLIENT_ROLE_UNSPECIFIED",
+ "CLIENT_DEAL_VIEWER",
+ "CLIENT_DEAL_NEGOTIATOR",
+ "CLIENT_DEAL_APPROVER"
+ ],
+ "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.",
+ "type": "string"
+ },
+ "visibleToSeller": {
+ "description": "Whether the client buyer will be visible to sellers.",
+ "type": "boolean"
+ },
+ "entityId": {
+ "type": "string",
+ "format": "int64",
+ "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile."
+ },
+ "clientAccountId": {
+ "type": "string",
+ "format": "int64",
+ "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations."
+ },
+ "entityName": {
+ "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the client buyer.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined client status.",
+ "A client that is currently disabled.",
+ "A client that is currently active."
+ ],
+ "enum": [
+ "CLIENT_STATUS_UNSPECIFIED",
+ "DISABLED",
+ "ACTIVE"
+ ]
+ }
+ },
+ "id": "Client"
+ },
+ "Correction": {
+ "description": "@OutputOnly Shows any corrections that were applied to this creative.",
+ "type": "object",
+ "properties": {
+ "contexts": {
+ "description": "The contexts for the correction.",
+ "items": {
+ "$ref": "ServingContext"
+ },
+ "type": "array"
+ },
+ "details": {
+ "description": "Additional details about what was corrected.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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."
+ ]
+ }
+ },
+ "id": "Correction"
+ },
+ "FilterSet": {
+ "type": "object",
+ "properties": {
+ "platforms": {
+ "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms).",
+ "items": {
+ "enum": [
+ "PLATFORM_UNSPECIFIED",
+ "DESKTOP",
+ "TABLET",
+ "MOBILE"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
+ "The ad impression appears on a desktop.",
+ "The ad impression appears on a tablet.",
+ "The ad impression appears on a mobile device."
+ ]
+ },
+ "relativeDateRange": {
+ "$ref": "RelativeDateRange",
+ "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
+ },
+ "sellerNetworkIds": {
+ "description": "The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "type": "array"
+ },
+ "ownerAccountId": {
+ "format": "int64",
+ "description": "The account ID of the buyer who owns this filter set.\nThe value of this field is ignored in create operations.",
+ "type": "string"
+ },
+ "buyerAccountId": {
+ "type": "string",
+ "format": "int64",
+ "description": "The ID of the buyer account on which to filter; optional."
+ },
+ "absoluteDateRange": {
+ "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone.",
+ "$ref": "AbsoluteDateRange"
+ },
+ "environment": {
+ "enumDescriptions": [
+ "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
+ "The ad impression appears on the web.",
+ "The ad impression appears in an app."
+ ],
+ "enum": [
+ "ENVIRONMENT_UNSPECIFIED",
+ "WEB",
+ "APP"
+ ],
+ "description": "The environment on which to filter; optional.",
+ "type": "string"
+ },
+ "dealId": {
+ "format": "int64",
+ "description": "The ID of the deal on which to filter; optional.",
+ "type": "string"
+ },
+ "format": {
+ "enumDescriptions": [
+ "A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
+ "The ad impression is display format (i.e. an image).",
+ "The ad impression is video format."
+ ],
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "DISPLAY",
+ "VIDEO"
+ ],
+ "description": "The format on which to filter; optional.",
+ "type": "string"
+ },
+ "timeSeriesGranularity": {
+ "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.",
+ "Indicates that data will be broken down by the hour.",
+ "Indicates that data will be broken down by the day."
+ ],
+ "enum": [
+ "TIME_SERIES_GRANULARITY_UNSPECIFIED",
+ "HOURLY",
+ "DAILY"
+ ]
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set; unique within the account of the filter set\nowner.\nThe value of this field is ignored in create operations.",
+ "type": "string"
+ },
+ "realtimeTimeRange": {
+ "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp.",
+ "$ref": "RealtimeTimeRange"
+ },
+ "creativeId": {
+ "description": "The ID of the creative on which to filter; optional.",
+ "type": "string"
+ }
+ },
+ "id": "FilterSet",
+ "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\""
}
},
- "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": {
@@ -3244,11 +3250,5 @@
}
}
}
- },
- "rootUrl": "https://adexchangebuyer.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "adexchangebuyer2",
- "batchPath": "batch",
- "title": "Ad Exchange Buyer API II",
- "ownerName": "Google"
+ }
}
diff --git a/adexperiencereport/v1/adexperiencereport-api.json b/adexperiencereport/v1/adexperiencereport-api.json
index 4e73ae2..05e71e2 100644
--- a/adexperiencereport/v1/adexperiencereport-api.json
+++ b/adexperiencereport/v1/adexperiencereport-api.json
@@ -1,17 +1,173 @@
{
+ "title": "Google Ad Experience Report API",
+ "ownerName": "Google",
+ "resources": {
+ "sites": {
+ "methods": {
+ "get": {
+ "description": "Gets a summary of the ad experience rating of a site.",
+ "response": {
+ "$ref": "SiteSummaryResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.",
+ "type": "string",
+ "required": true,
+ "pattern": "^sites/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ],
+ "flatPath": "v1/sites/{sitesId}",
+ "id": "adexperiencereport.sites.get",
+ "path": "v1/{+name}"
+ }
+ }
+ },
+ "violatingSites": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ViolatingSitesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ],
+ "parameters": {},
+ "flatPath": "v1/violatingSites",
+ "path": "v1/violatingSites",
+ "id": "adexperiencereport.violatingSites.list",
+ "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\"."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "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.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
"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": "",
+ "kind": "discovery#restDescription",
+ "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
"basePath": "",
- "id": "adexperiencereport:v1",
- "documentationLink": "https://developers.google.com/ad-experience-report/",
"revision": "20170819",
+ "documentationLink": "https://developers.google.com/ad-experience-report/",
+ "id": "adexperiencereport:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "ViolatingSitesResponse": {
+ "description": "Response message for ListViolatingSites.",
+ "type": "object",
+ "properties": {
+ "violatingSites": {
+ "description": "A list of summaries of violating sites.",
+ "items": {
+ "$ref": "SiteSummaryResponse"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ViolatingSitesResponse"
+ },
"SiteSummaryResponse": {
+ "description": "Response message for GetSiteSummary.",
+ "type": "object",
"properties": {
"mobileSummary": {
"description": "Summary for the mobile review of the site.",
@@ -26,20 +182,49 @@
"$ref": "PlatformSummary"
}
},
- "id": "SiteSummaryResponse",
- "description": "Response message for GetSiteSummary.",
- "type": "object"
+ "id": "SiteSummaryResponse"
},
"PlatformSummary": {
"description": "Summary of the ad experience rating of a site for a specific platform.",
"type": "object",
"properties": {
+ "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"
+ ]
+ },
+ "abusiveStatus": {
+ "description": "The status of the site reviewed for abusive ads.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not reviewed.",
+ "Passing.",
+ "Failing."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PASSING",
+ "FAILING"
+ ]
+ },
"enforcementTime": {
"format": "google-datetime",
"description": "The date on which ad filtering begins.",
"type": "string"
},
"region": {
+ "description": "The assigned regions for the site and platform.",
"items": {
"enum": [
"REGION_UNKNOWN",
@@ -53,10 +238,11 @@
"Ad standard not yet defined for your region.",
"Region A.",
"Region B."
- ],
- "description": "The assigned regions for the site and platform."
+ ]
},
"filterStatus": {
+ "description": "The ad filtering status of the site.",
+ "type": "string",
"enumDescriptions": [
"N/A.",
"Ad filtering is on.",
@@ -70,9 +256,7 @@
"OFF",
"PAUSED",
"PENDING"
- ],
- "description": "The ad filtering status of the site.",
- "type": "string"
+ ]
},
"underReview": {
"description": "Whether the site is currently under review.",
@@ -86,60 +270,16 @@
"format": "google-datetime",
"description": "The last time that the site changed status.",
"type": "string"
- },
- "betterAdsStatus": {
- "enumDescriptions": [
- "Not reviewed.",
- "Passing.",
- "Warning.",
- "Failing."
- ],
- "enum": [
- "UNKNOWN",
- "PASSING",
- "WARNING",
- "FAILING"
- ],
- "description": "The status of the site reviewed for the Better Ads Standards.",
- "type": "string"
- },
- "abusiveStatus": {
- "enumDescriptions": [
- "Not reviewed.",
- "Passing.",
- "Failing."
- ],
- "enum": [
- "UNKNOWN",
- "PASSING",
- "FAILING"
- ],
- "description": "The status of the site reviewed for abusive ads.",
- "type": "string"
}
},
"id": "PlatformSummary"
- },
- "ViolatingSitesResponse": {
- "description": "Response message for ListViolatingSites.",
- "type": "object",
- "properties": {
- "violatingSites": {
- "description": "A list of summaries of violating sites.",
- "items": {
- "$ref": "SiteSummaryResponse"
- },
- "type": "array"
- }
- },
- "id": "ViolatingSitesResponse"
}
},
+ "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": "Ad Experience Report",
"auth": {
"oauth2": {
@@ -153,145 +293,5 @@
"rootUrl": "https://adexperiencereport.googleapis.com/",
"ownerDomain": "google.com",
"name": "adexperiencereport",
- "batchPath": "batch",
- "title": "Google Ad Experience Report API",
- "ownerName": "Google",
- "resources": {
- "sites": {
- "methods": {
- "get": {
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^sites/[^/]+$",
- "location": "path",
- "description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
- "flatPath": "v1/sites/{sitesId}",
- "id": "adexperiencereport.sites.get",
- "path": "v1/{+name}",
- "description": "Gets a summary of the ad experience rating of a site.",
- "response": {
- "$ref": "SiteSummaryResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET"
- }
- }
- },
- "violatingSites": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ViolatingSitesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
- "parameters": {},
- "flatPath": "v1/violatingSites",
- "id": "adexperiencereport.violatingSites.list",
- "path": "v1/violatingSites",
- "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\"."
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "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.",
- "default": "true",
- "type": "boolean"
- },
- "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": {
- "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"
- },
- "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"
- }
- }
+ "batchPath": "batch"
}
diff --git a/analyticsreporting/v4/analyticsreporting-api.json b/analyticsreporting/v4/analyticsreporting-api.json
index 4923ac9..53cdc28 100644
--- a/analyticsreporting/v4/analyticsreporting-api.json
+++ b/analyticsreporting/v4/analyticsreporting-api.json
@@ -1,367 +1,131 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "reports": {
+ "methods": {
+ "batchGet": {
+ "description": "Returns the Analytics data.",
+ "request": {
+ "$ref": "GetReportsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GetReportsResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ],
+ "flatPath": "v4/reports:batchGet",
+ "path": "v4/reports:batchGet",
+ "id": "analyticsreporting.reports.batchGet"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v4",
+ "baseUrl": "https://analyticsreporting.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Accesses Analytics report data.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170705",
+ "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
+ "id": "analyticsreporting:v4",
+ "discoveryVersion": "v1",
+ "version_module": "True",
"schemas": {
- "DimensionFilterClause": {
- "properties": {
- "filters": {
- "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
- "items": {
- "$ref": "DimensionFilter"
- },
- "type": "array"
- },
- "operator": {
- "enumDescriptions": [
- "Unspecified operator. It is treated as an `OR`.",
- "The logical `OR` operator.",
- "The logical `AND` operator."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "OR",
- "AND"
- ],
- "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
- "type": "string"
- }
- },
- "id": "DimensionFilterClause",
- "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
- "type": "object"
- },
- "GetReportsResponse": {
- "properties": {
- "reports": {
- "description": "Responses corresponding to each of the request.",
- "items": {
- "$ref": "Report"
- },
- "type": "array"
- }
- },
- "id": "GetReportsResponse",
- "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
- "type": "object"
- },
- "SequenceSegment": {
- "properties": {
- "firstStepShouldMatchFirstHit": {
- "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).",
- "type": "boolean"
- },
- "segmentSequenceSteps": {
- "description": "The list of steps in the sequence.",
- "items": {
- "$ref": "SegmentSequenceStep"
- },
- "type": "array"
- }
- },
- "id": "SequenceSegment",
- "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
- "type": "object"
- },
- "SegmentMetricFilter": {
- "description": "Metric filter to be used in a segment filter clause.",
- "type": "object",
- "properties": {
- "operator": {
- "enumDescriptions": [
- "Unspecified operator is treated as `LESS_THAN` operator.",
- "Checks if the metric value is less than comparison value.",
- "Checks if the metric value is greater than comparison value.",
- "Equals operator.",
- "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison."
- ],
- "enum": [
- "UNSPECIFIED_OPERATOR",
- "LESS_THAN",
- "GREATER_THAN",
- "EQUAL",
- "BETWEEN"
- ],
- "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"
- },
- "scope": {
- "enumDescriptions": [
- "If the scope is unspecified, it defaults to the condition scope,\n`USER` or `SESSION` depending on if the segment is trying to choose\nusers or sessions.",
- "Product scope.",
- "Hit scope.",
- "Session scope.",
- "User scope."
- ],
- "enum": [
- "UNSPECIFIED_SCOPE",
- "PRODUCT",
- "HIT",
- "SESSION",
- "USER"
- ],
- "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.",
- "type": "string"
- },
- "maxComparisonValue": {
- "description": "Max comparison value is only used for `BETWEEN` operator.",
- "type": "string"
- },
- "comparisonValue": {
- "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
- "type": "string"
- }
- },
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pivotValueRegions": {
- "description": "The values of each pivot region.",
- "items": {
- "$ref": "PivotValueRegion"
- },
- "type": "array"
- }
- },
- "id": "DateRangeValues"
- },
- "CohortGroup": {
- "properties": {
- "lifetimeValue": {
- "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
- "type": "boolean"
- },
- "cohorts": {
- "description": "The definition for the cohort.",
- "items": {
- "$ref": "Cohort"
- },
- "type": "array"
- }
- },
- "id": "CohortGroup",
- "description": "Defines a cohort group.\nFor example:\n\n \"cohortGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"type\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }",
- "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`.",
- "items": {
- "$ref": "ReportRequest"
- },
- "type": "array"
- }
- },
- "id": "GetReportsRequest"
- },
- "Pivot": {
- "properties": {
- "startGroup": {
- "format": "int32",
- "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
- "type": "integer"
- },
- "metrics": {
- "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
- "items": {
- "$ref": "Metric"
- },
- "type": "array"
- },
- "dimensionFilterClauses": {
- "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
- "items": {
- "$ref": "DimensionFilterClause"
- },
- "type": "array"
- },
- "dimensions": {
- "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
- "maxGroupCount": {
- "format": "int32",
- "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
- "type": "integer"
- }
- },
- "id": "Pivot",
- "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
- "type": "object"
- },
- "PivotHeaderEntry": {
- "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
- "type": "object",
- "properties": {
- "metric": {
- "description": "The metric header for the metric in the pivot.",
- "$ref": "MetricHeaderEntry"
- },
- "dimensionNames": {
- "description": "The name of the dimensions in the pivot response.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "dimensionValues": {
- "description": "The values for the dimensions in the pivot.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "PivotHeaderEntry"
- },
- "SegmentFilter": {
- "properties": {
- "sequenceSegment": {
- "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators.",
- "$ref": "SequenceSegment"
- },
- "not": {
- "description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
- "type": "boolean"
- },
- "simpleSegment": {
- "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined",
- "$ref": "SimpleSegment"
- }
- },
- "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"
- },
- "SegmentDefinition": {
- "properties": {
- "segmentFilters": {
- "description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
- "items": {
- "$ref": "SegmentFilter"
- },
- "type": "array"
- }
- },
- "id": "SegmentDefinition",
- "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
- "type": "object"
- },
- "MetricHeaderEntry": {
- "description": "Header for the metrics.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the header.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "Metric type is unspecified.",
- "Integer metric.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ],
- "enum": [
- "METRIC_TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "CURRENCY",
- "PERCENT",
- "TIME"
- ],
- "description": "The type of the metric, for example `INTEGER`.",
- "type": "string"
- }
- },
- "id": "MetricHeaderEntry"
- },
- "ReportData": {
- "properties": {
- "rowCount": {
- "format": "int32",
- "description": "Total number of matching rows for this query.",
- "type": "integer"
- },
- "rows": {
- "description": "There's one ReportRow for every unique combination of dimensions.",
- "items": {
- "$ref": "ReportRow"
- },
- "type": "array"
- },
- "isDataGolden": {
- "description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
- "type": "boolean"
- },
- "dataLastRefreshed": {
- "format": "google-datetime",
- "description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
- "type": "string"
- },
- "maximums": {
- "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
- "items": {
- "$ref": "DateRangeValues"
- },
- "type": "array"
- },
- "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.",
- "items": {
- "$ref": "DateRangeValues"
- },
- "type": "array"
- },
- "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.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "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.",
- "items": {
- "$ref": "DateRangeValues"
- },
- "type": "array"
- },
- "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.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "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": {
@@ -369,6 +133,8 @@
"type": "boolean"
},
"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.",
@@ -392,9 +158,7 @@
"NUMERIC_GREATER_THAN",
"NUMERIC_LESS_THAN",
"IN_LIST"
- ],
- "description": "How to match the dimension to the expression. The default is REGEXP.",
- "type": "string"
+ ]
},
"dimensionName": {
"description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
@@ -412,12 +176,17 @@
"type": "boolean"
}
},
- "id": "DimensionFilter"
+ "id": "DimensionFilter",
+ "description": "Dimension filter specifies the filtering options on a dimension."
},
"SegmentDimensionFilter": {
"description": "Dimension filter specifies the filtering options on a dimension.",
"type": "object",
"properties": {
+ "minComparisonValue": {
+ "description": "Minimum comparison values for `BETWEEN` match type.",
+ "type": "string"
+ },
"maxComparisonValue": {
"description": "Maximum comparison values for `BETWEEN` match type.",
"type": "string"
@@ -427,19 +196,6 @@
"type": "string"
},
"operator": {
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "REGEXP",
- "BEGINS_WITH",
- "ENDS_WITH",
- "PARTIAL",
- "EXACT",
- "IN_LIST",
- "NUMERIC_LESS_THAN",
- "NUMERIC_GREATER_THAN",
- "NUMERIC_BETWEEN"
- ],
- "description": "The operator to use to match the dimension with the expressions.",
"type": "string",
"enumDescriptions": [
"If the match type is unspecified, it is treated as a REGEXP.",
@@ -452,46 +208,47 @@
"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."
},
"expressions": {
- "description": "The list of expressions, only the first element is used for all operators",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "The list of expressions, only the first element is used for all operators"
},
"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"
},
- "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": {
- "description": "Specifies the sorting options.",
"type": "object",
"properties": {
"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",
@@ -501,19 +258,11 @@
"DIMENSION_AS_INTEGER"
],
"description": "The order type. The default orderType is `VALUE`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified order type will be treated as sort based on value.",
- "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
- "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
- "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
- "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
- "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
- ]
+ "type": "string"
},
"fieldName": {
- "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
- "type": "string"
+ "type": "string",
+ "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid."
},
"sortOrder": {
"enumDescriptions": [
@@ -530,7 +279,23 @@
"type": "string"
}
},
- "id": "OrderBy"
+ "id": "OrderBy",
+ "description": "Specifies the sorting options."
+ },
+ "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": {
"description": "A segment sequence definition.",
@@ -544,6 +309,8 @@
"type": "array"
},
"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.",
@@ -553,16 +320,28 @@
"UNSPECIFIED_MATCH_TYPE",
"PRECEDES",
"IMMEDIATELY_PRECEDES"
- ],
- "description": "Specifies if the step immediately precedes or can be any time before the\nnext step.",
- "type": "string"
+ ]
}
},
"id": "SegmentSequenceStep"
},
"Metric": {
+ "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
+ "type": "object",
"properties": {
+ "expression": {
+ "type": "string",
+ "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results."
+ },
"formattingType": {
+ "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",
@@ -572,28 +351,14 @@
"TIME"
],
"description": "Specifies how the metric expression should be formatted, for example\n`INTEGER`.",
- "type": "string",
- "enumDescriptions": [
- "Metric type is unspecified.",
- "Integer metric.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ]
+ "type": "string"
},
"alias": {
"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.",
- "type": "object"
+ "id": "Metric"
},
"PivotValueRegion": {
"description": "The metric values in the pivot region.",
@@ -613,10 +378,6 @@
"description": "The data response corresponding to the request.",
"type": "object",
"properties": {
- "columnHeader": {
- "description": "The column headers.",
- "$ref": "ColumnHeader"
- },
"nextPageToken": {
"description": "Page token to retrieve the next page of results in the list.",
"type": "string"
@@ -624,11 +385,16 @@
"data": {
"$ref": "ReportData",
"description": "Response data."
+ },
+ "columnHeader": {
+ "$ref": "ColumnHeader",
+ "description": "The column headers."
}
},
"id": "Report"
},
"PivotHeader": {
+ "type": "object",
"properties": {
"pivotHeaderEntries": {
"description": "A single pivot section header.",
@@ -644,62 +410,25 @@
}
},
"id": "PivotHeader",
- "description": "The headers for each of the pivot sections defined in the request.",
- "type": "object"
+ "description": "The headers for each of the pivot sections defined in the request."
},
"DateRange": {
"description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.",
"type": "object",
"properties": {
- "endDate": {
- "description": "The end date for the query in the format `YYYY-MM-DD`.",
- "type": "string"
- },
"startDate": {
"description": "The start date for the query in the format `YYYY-MM-DD`.",
"type": "string"
+ },
+ "endDate": {
+ "description": "The end date for the query in the format `YYYY-MM-DD`.",
+ "type": "string"
}
},
"id": "DateRange"
},
- "MetricFilter": {
- "description": "MetricFilter specifies the filter on a metric.",
- "type": "object",
- "properties": {
- "operator": {
- "enumDescriptions": [
- "If the operator is not specified, it is treated as `EQUAL`.",
- "Should the value of the metric be exactly equal to the comparison value.",
- "Should the value of the metric be less than to the comparison value.",
- "Should the value of the metric be greater than to the comparison value.",
- "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "EQUAL",
- "LESS_THAN",
- "GREATER_THAN",
- "IS_MISSING"
- ],
- "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
- "type": "string"
- },
- "not": {
- "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
- "type": "boolean"
- },
- "metricName": {
- "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
- "type": "string"
- },
- "comparisonValue": {
- "description": "The value to compare against.",
- "type": "string"
- }
- },
- "id": "MetricFilter"
- },
"ReportRequest": {
+ "type": "object",
"properties": {
"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.",
@@ -721,14 +450,14 @@
"description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
"type": "boolean"
},
+ "cohortGroup": {
+ "$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"
},
- "cohortGroup": {
- "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition.",
- "$ref": "CohortGroup"
- },
"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"
@@ -762,6 +491,7 @@
"type": "array"
},
"samplingLevel": {
+ "type": "string",
"enumDescriptions": [
"If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.",
"Returns response with a sample size that balances speed and\naccuracy.",
@@ -774,8 +504,7 @@
"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"
+ "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details."
},
"dimensions": {
"description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
@@ -796,11 +525,11 @@
"type": "array"
},
"pivots": {
- "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
"items": {
"$ref": "Pivot"
},
- "type": "array"
+ "type": "array",
+ "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.",
@@ -808,8 +537,44 @@
}
},
"id": "ReportRequest",
- "description": "The main request class which specifies the Reporting API request.",
- "type": "object"
+ "description": "The main request class which specifies the Reporting API request."
+ },
+ "MetricFilter": {
+ "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": {
+ "description": "The value to compare against.",
+ "type": "string"
+ },
+ "operator": {
+ "enumDescriptions": [
+ "If the operator is not specified, it is treated as `EQUAL`.",
+ "Should the value of the metric be exactly equal to the comparison value.",
+ "Should the value of the metric be less than to the comparison value.",
+ "Should the value of the metric be greater than to the comparison value.",
+ "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "EQUAL",
+ "LESS_THAN",
+ "GREATER_THAN",
+ "IS_MISSING"
+ ],
+ "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
+ "type": "string"
+ },
+ "not": {
+ "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
+ "type": "boolean"
+ }
+ },
+ "id": "MetricFilter",
+ "description": "MetricFilter specifies the filter on a metric."
},
"Dimension": {
"description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.",
@@ -830,7 +595,27 @@
},
"id": "Dimension"
},
+ "DynamicSegment": {
+ "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the dynamic segment.",
+ "type": "string"
+ },
+ "userSegment": {
+ "description": "User Segment to select users to include in the segment.",
+ "$ref": "SegmentDefinition"
+ },
+ "sessionSegment": {
+ "description": "Session Segment to select sessions to include in the segment.",
+ "$ref": "SegmentDefinition"
+ }
+ },
+ "id": "DynamicSegment"
+ },
"SimpleSegment": {
+ "id": "SimpleSegment",
"description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
"type": "object",
"properties": {
@@ -841,29 +626,11 @@
},
"type": "array"
}
- },
- "id": "SimpleSegment"
- },
- "DynamicSegment": {
- "properties": {
- "sessionSegment": {
- "description": "Session Segment to select sessions to include in the segment.",
- "$ref": "SegmentDefinition"
- },
- "name": {
- "description": "The name of the dynamic segment.",
- "type": "string"
- },
- "userSegment": {
- "$ref": "SegmentDefinition",
- "description": "User Segment to select users to include in the segment."
- }
- },
- "id": "DynamicSegment",
- "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
- "type": "object"
+ }
},
"ColumnHeader": {
+ "description": "Column headers.",
+ "type": "object",
"properties": {
"dimensions": {
"description": "The dimension names in the response.",
@@ -877,49 +644,75 @@
"description": "Metric headers for the metrics in the response."
}
},
- "id": "ColumnHeader",
- "description": "Column headers.",
- "type": "object"
+ "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": {
+ "dimensionFilter": {
+ "$ref": "SegmentDimensionFilter",
+ "description": "Dimension Filter for the segment definition."
+ },
"metricFilter": {
"description": "Metric Filter for the segment definition.",
"$ref": "SegmentMetricFilter"
},
"not": {
- "description": "Matches the complement (`!`) of the filter.",
- "type": "boolean"
- },
- "dimensionFilter": {
- "description": "Dimension Filter for the segment definition.",
- "$ref": "SegmentDimensionFilter"
+ "type": "boolean",
+ "description": "Matches the complement (`!`) of the filter."
}
},
"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": {
+ "filters": {
+ "items": {
+ "$ref": "MetricFilter"
+ },
+ "type": "array",
+ "description": "The repeated set of filters. They are logically combined based on the\noperator specified."
+ },
+ "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"
+ ]
+ }
+ },
+ "id": "MetricFilterClause"
+ },
"ReportRow": {
+ "id": "ReportRow",
"description": "A row in the report.",
"type": "object",
"properties": {
- "metrics": {
- "description": "List of metrics for each requested DateRange.",
- "items": {
- "$ref": "DateRangeValues"
- },
- "type": "array"
- },
"dimensions": {
"description": "List of requested dimensions.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "metrics": {
+ "description": "List of metrics for each requested DateRange.",
+ "items": {
+ "$ref": "DateRangeValues"
+ },
+ "type": "array"
}
- },
- "id": "ReportRow"
+ }
},
"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.",
@@ -934,51 +727,21 @@
"type": "string"
},
"type": {
- "enum": [
- "UNSPECIFIED_COHORT_TYPE",
- "FIRST_VISIT_DATE"
- ],
"description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated\nas `FIRST_VISIT_DATE` type cohort.",
"type": "string",
"enumDescriptions": [
"If unspecified it's treated as `FIRST_VISIT_DATE`.",
"Cohorts that are selected based on first visit date."
+ ],
+ "enum": [
+ "UNSPECIFIED_COHORT_TYPE",
+ "FIRST_VISIT_DATE"
]
}
},
"id": "Cohort"
},
- "MetricFilterClause": {
- "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
- "type": "object",
- "properties": {
- "filters": {
- "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
- "items": {
- "$ref": "MetricFilter"
- },
- "type": "array"
- },
- "operator": {
- "enumDescriptions": [
- "Unspecified operator. It is treated as an `OR`.",
- "The logical `OR` operator.",
- "The logical `AND` operator."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "OR",
- "AND"
- ],
- "description": "The operator for combining multiple metric filters. If unspecified, it is\ntreated as an `OR`.",
- "type": "string"
- }
- },
- "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.",
@@ -988,7 +751,9 @@
"type": "array"
}
},
- "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.",
@@ -1010,22 +775,382 @@
}
},
"id": "MetricHeader"
+ },
+ "DimensionFilterClause": {
+ "id": "DimensionFilterClause",
+ "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
+ "type": "object",
+ "properties": {
+ "filters": {
+ "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
+ "items": {
+ "$ref": "DimensionFilter"
+ },
+ "type": "array"
+ },
+ "operator": {
+ "enumDescriptions": [
+ "Unspecified operator. It is treated as an `OR`.",
+ "The logical `OR` operator.",
+ "The logical `AND` operator."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "OR",
+ "AND"
+ ],
+ "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
+ "type": "string"
+ }
+ }
+ },
+ "GetReportsResponse": {
+ "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
+ "type": "object",
+ "properties": {
+ "reports": {
+ "description": "Responses corresponding to each of the request.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GetReportsResponse"
+ },
+ "SequenceSegment": {
+ "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
+ "type": "object",
+ "properties": {
+ "firstStepShouldMatchFirstHit": {
+ "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).",
+ "type": "boolean"
+ },
+ "segmentSequenceSteps": {
+ "description": "The list of steps in the sequence.",
+ "items": {
+ "$ref": "SegmentSequenceStep"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SequenceSegment"
+ },
+ "SegmentMetricFilter": {
+ "description": "Metric filter to be used in a segment filter clause.",
+ "type": "object",
+ "properties": {
+ "maxComparisonValue": {
+ "description": "Max comparison value is only used for `BETWEEN` operator.",
+ "type": "string"
+ },
+ "comparisonValue": {
+ "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
+ "type": "string"
+ },
+ "operator": {
+ "enum": [
+ "UNSPECIFIED_OPERATOR",
+ "LESS_THAN",
+ "GREATER_THAN",
+ "EQUAL",
+ "BETWEEN"
+ ],
+ "description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified operator is treated as `LESS_THAN` operator.",
+ "Checks if the metric value is less than comparison value.",
+ "Checks if the metric value is greater than comparison value.",
+ "Equals operator.",
+ "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison."
+ ]
+ },
+ "metricName": {
+ "description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.",
+ "type": "string"
+ },
+ "scope": {
+ "enumDescriptions": [
+ "If the scope is unspecified, it defaults to the condition scope,\n`USER` or `SESSION` depending on if the segment is trying to choose\nusers or sessions.",
+ "Product scope.",
+ "Hit scope.",
+ "Session scope.",
+ "User scope."
+ ],
+ "enum": [
+ "UNSPECIFIED_SCOPE",
+ "PRODUCT",
+ "HIT",
+ "SESSION",
+ "USER"
+ ],
+ "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.",
+ "type": "string"
+ }
+ },
+ "id": "SegmentMetricFilter"
+ },
+ "DateRangeValues": {
+ "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
+ "type": "object",
+ "properties": {
+ "pivotValueRegions": {
+ "description": "The values of each pivot region.",
+ "items": {
+ "$ref": "PivotValueRegion"
+ },
+ "type": "array"
+ },
+ "values": {
+ "description": "Each value corresponds to each Metric in the request.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "DateRangeValues"
+ },
+ "CohortGroup": {
+ "description": "Defines a cohort group.\nFor example:\n\n \"cohortGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"type\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }",
+ "type": "object",
+ "properties": {
+ "cohorts": {
+ "description": "The definition for the cohort.",
+ "items": {
+ "$ref": "Cohort"
+ },
+ "type": "array"
+ },
+ "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)"
+ }
+ },
+ "id": "CohortGroup"
+ },
+ "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`.",
+ "items": {
+ "$ref": "ReportRequest"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GetReportsRequest"
+ },
+ "Pivot": {
+ "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
+ "type": "object",
+ "properties": {
+ "maxGroupCount": {
+ "format": "int32",
+ "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
+ "type": "integer"
+ },
+ "startGroup": {
+ "format": "int32",
+ "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
+ "items": {
+ "$ref": "Metric"
+ },
+ "type": "array"
+ },
+ "dimensionFilterClauses": {
+ "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
+ "items": {
+ "$ref": "DimensionFilterClause"
+ },
+ "type": "array"
+ },
+ "dimensions": {
+ "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Pivot"
+ },
+ "PivotHeaderEntry": {
+ "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
+ "type": "object",
+ "properties": {
+ "dimensionValues": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "The values for the dimensions in the pivot."
+ },
+ "metric": {
+ "description": "The metric header for the metric in the pivot.",
+ "$ref": "MetricHeaderEntry"
+ },
+ "dimensionNames": {
+ "description": "The name of the dimensions in the pivot response.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "PivotHeaderEntry"
+ },
+ "SegmentFilter": {
+ "description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
+ "type": "object",
+ "properties": {
+ "sequenceSegment": {
+ "$ref": "SequenceSegment",
+ "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators."
+ },
+ "not": {
+ "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 },"
+ },
+ "simpleSegment": {
+ "$ref": "SimpleSegment",
+ "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
+ }
+ },
+ "id": "SegmentFilter"
+ },
+ "SegmentDefinition": {
+ "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
+ "type": "object",
+ "properties": {
+ "segmentFilters": {
+ "description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
+ "items": {
+ "$ref": "SegmentFilter"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SegmentDefinition"
+ },
+ "MetricHeaderEntry": {
+ "description": "Header for the metrics.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "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."
+ ],
+ "enum": [
+ "METRIC_TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "CURRENCY",
+ "PERCENT",
+ "TIME"
+ ]
+ },
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ }
+ },
+ "id": "MetricHeaderEntry"
+ },
+ "ReportData": {
+ "description": "The data part of the report.",
+ "type": "object",
+ "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.",
+ "items": {
+ "$ref": "DateRangeValues"
+ },
+ "type": "array"
+ },
+ "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.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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.",
+ "items": {
+ "$ref": "DateRangeValues"
+ },
+ "type": "array"
+ },
+ "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.",
+ "items": {
+ "type": "string",
+ "format": "int64"
+ },
+ "type": "array"
+ },
+ "rowCount": {
+ "format": "int32",
+ "description": "Total number of matching rows for this query.",
+ "type": "integer"
+ },
+ "rows": {
+ "description": "There's one ReportRow for every unique combination of dimensions.",
+ "items": {
+ "$ref": "ReportRow"
+ },
+ "type": "array"
+ },
+ "isDataGolden": {
+ "description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
+ "type": "boolean"
+ },
+ "dataLastRefreshed": {
+ "format": "google-datetime",
+ "description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
+ "type": "string"
+ },
+ "maximums": {
+ "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
+ "items": {
+ "$ref": "DateRangeValues"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ReportData"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "AnalyticsReporting",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/analytics.readonly": {
- "description": "View your Google Analytics data"
- },
"https://www.googleapis.com/auth/analytics": {
"description": "View and manage your Google Analytics data"
+ },
+ "https://www.googleapis.com/auth/analytics.readonly": {
+ "description": "View your Google Analytics data"
}
}
}
@@ -1034,130 +1159,5 @@
"ownerDomain": "google.com",
"name": "analyticsreporting",
"batchPath": "batch",
- "title": "Google Analytics Reporting API",
- "ownerName": "Google",
- "resources": {
- "reports": {
- "methods": {
- "batchGet": {
- "response": {
- "$ref": "GetReportsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ],
- "parameters": {},
- "flatPath": "v4/reports:batchGet",
- "id": "analyticsreporting.reports.batchGet",
- "path": "v4/reports:batchGet",
- "request": {
- "$ref": "GetReportsRequest"
- },
- "description": "Returns the Analytics data."
- }
- }
- }
- },
- "parameters": {
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- }
- },
- "version": "v4",
- "baseUrl": "https://analyticsreporting.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Accesses Analytics report data.",
- "servicePath": "",
- "basePath": "",
- "revision": "20170705",
- "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
- "id": "analyticsreporting:v4",
- "discoveryVersion": "v1",
- "version_module": "True"
+ "title": "Google Analytics Reporting API"
}
diff --git a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
index ebc8dad..56583f5 100644
--- a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
+++ b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
@@ -1,51 +1,92 @@
{
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "androiddeviceprovisioning",
- "batchPath": "batch",
- "revision": "20170819",
- "documentationLink": "https://developers.google.com/zero-touch/",
- "id": "androiddeviceprovisioning:v1",
- "title": "Android Device Provisioning Partner API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
"operations": {
"methods": {
"get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"parameters": {
"name": {
+ "pattern": "^operations/.+$",
"location": "path",
"description": "The name of the operation resource.",
"type": "string",
- "required": true,
- "pattern": "^operations/.+$"
+ "required": true
}
},
"flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
"id": "androiddeviceprovisioning.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ "path": "v1/{+name}"
}
}
},
"partners": {
"resources": {
+ "customers": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/partners/{partnersId}/customers",
+ "id": "androiddeviceprovisioning.partners.customers.list",
+ "path": "v1/partners/{+partnerId}/customers",
+ "description": "List all the customers that has delegates some role to this customer.",
+ "response": {
+ "$ref": "ListCustomersResponse"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "partnerId": {
+ "format": "int64",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "the id of the partner.",
+ "pattern": "^[^/]+$"
+ }
+ }
+ }
+ }
+ },
"devices": {
"methods": {
- "claimAsync": {
+ "claim": {
"request": {
- "$ref": "ClaimDevicesRequest"
+ "$ref": "ClaimDeviceRequest"
},
- "description": "Claim devices asynchronously",
+ "description": "Claim the device identified by device identifier.",
+ "response": {
+ "$ref": "ClaimDeviceResponse"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "partnerId": {
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Id of the partner."
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:claim",
+ "id": "androiddeviceprovisioning.partners.devices.claim",
+ "path": "v1/partners/{+partnerId}/devices:claim"
+ },
+ "claimAsync": {
"response": {
"$ref": "Operation"
},
@@ -65,15 +106,13 @@
},
"flatPath": "v1/partners/{partnersId}/devices:claimAsync",
"id": "androiddeviceprovisioning.partners.devices.claimAsync",
- "path": "v1/partners/{+partnerId}/devices:claimAsync"
+ "path": "v1/partners/{+partnerId}/devices:claimAsync",
+ "request": {
+ "$ref": "ClaimDevicesRequest"
+ },
+ "description": "Claim devices asynchronously"
},
"findByIdentifier": {
- "id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
- "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
- "request": {
- "$ref": "FindDevicesByDeviceIdentifierRequest"
- },
- "description": "Find devices by device identifier.",
"response": {
"$ref": "FindDevicesByDeviceIdentifierResponse"
},
@@ -83,24 +122,34 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
- "location": "path",
- "description": "id of the partner.",
"pattern": "^[^/]+$",
"format": "int64",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "id of the partner."
}
},
- "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier"
+ "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
+ "id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
+ "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
+ "request": {
+ "$ref": "FindDevicesByDeviceIdentifierRequest"
+ },
+ "description": "Find devices by device identifier."
},
"unclaimAsync": {
- "response": {
- "$ref": "Operation"
+ "request": {
+ "$ref": "UnclaimDevicesRequest"
},
+ "description": "Unclaim devices asynchronously",
+ "httpMethod": "POST",
"parameterOrder": [
"partnerId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"partnerId": {
"format": "int64",
@@ -112,12 +161,8 @@
}
},
"flatPath": "v1/partners/{partnersId}/devices:unclaimAsync",
- "id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
"path": "v1/partners/{+partnerId}/devices:unclaimAsync",
- "request": {
- "$ref": "UnclaimDevicesRequest"
- },
- "description": "Unclaim devices asynchronously"
+ "id": "androiddeviceprovisioning.partners.devices.unclaimAsync"
},
"metadata": {
"httpMethod": "POST",
@@ -134,16 +179,16 @@
"description": "The owner of the newly set metadata. Should be partner id itself.",
"pattern": "^[^/]+$",
"format": "int64",
- "required": true,
- "type": "string"
+ "type": "string",
+ "required": true
},
"deviceId": {
- "format": "int64",
- "required": true,
- "type": "string",
"location": "path",
"description": "id of the partner.",
- "pattern": "^[^/]+$"
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "type": "string",
+ "required": true
}
},
"flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
@@ -155,10 +200,6 @@
}
},
"updateMetadataAsync": {
- "description": "Set metadata in batch asynchronously.",
- "request": {
- "$ref": "UpdateDeviceMetadataInBatchRequest"
- },
"httpMethod": "POST",
"parameterOrder": [
"partnerId"
@@ -178,7 +219,11 @@
},
"flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
"path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
- "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync"
+ "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync",
+ "description": "Set metadata in batch asynchronously.",
+ "request": {
+ "$ref": "UpdateDeviceMetadataInBatchRequest"
+ }
},
"get": {
"description": "Get a device",
@@ -191,11 +236,11 @@
"httpMethod": "GET",
"parameters": {
"name": {
- "location": "path",
"description": "resource name in 'partners/[PARTNER_ID]/devices/[DEVICE_ID]'.",
"type": "string",
"required": true,
- "pattern": "^partners/[^/]+/devices/[^/]+$"
+ "pattern": "^partners/[^/]+/devices/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
@@ -203,10 +248,12 @@
"path": "v1/{+name}"
},
"unclaim": {
- "description": "Unclaim the device identified by device_id or identifier.",
+ "path": "v1/partners/{+partnerId}/devices:unclaim",
+ "id": "androiddeviceprovisioning.partners.devices.unclaim",
"request": {
"$ref": "UnclaimDeviceRequest"
},
+ "description": "Unclaim the device identified by device_id or identifier.",
"httpMethod": "POST",
"parameterOrder": [
"partnerId"
@@ -216,23 +263,17 @@
},
"parameters": {
"partnerId": {
- "format": "int64",
- "type": "string",
- "required": true,
- "location": "path",
"description": "Id of the partner.",
- "pattern": "^[^/]+$"
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
- "flatPath": "v1/partners/{partnersId}/devices:unclaim",
- "path": "v1/partners/{+partnerId}/devices:unclaim",
- "id": "androiddeviceprovisioning.partners.devices.unclaim"
+ "flatPath": "v1/partners/{partnersId}/devices:unclaim"
},
"findByOwner": {
- "request": {
- "$ref": "FindDevicesByOwnerRequest"
- },
- "description": "Find devices by ownership.",
"response": {
"$ref": "FindDevicesByOwnerResponse"
},
@@ -242,70 +283,21 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
+ "format": "int64",
+ "required": true,
+ "type": "string",
"location": "path",
"description": "id of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "type": "string",
- "required": true
+ "pattern": "^[^/]+$"
}
},
"flatPath": "v1/partners/{partnersId}/devices:findByOwner",
"id": "androiddeviceprovisioning.partners.devices.findByOwner",
- "path": "v1/partners/{+partnerId}/devices:findByOwner"
- },
- "claim": {
- "response": {
- "$ref": "ClaimDeviceResponse"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
- "description": "Id of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:claim",
- "id": "androiddeviceprovisioning.partners.devices.claim",
- "path": "v1/partners/{+partnerId}/devices:claim",
+ "path": "v1/partners/{+partnerId}/devices:findByOwner",
+ "description": "Find devices by ownership.",
"request": {
- "$ref": "ClaimDeviceRequest"
- },
- "description": "Claim the device identified by device identifier."
- }
- }
- },
- "customers": {
- "methods": {
- "list": {
- "description": "List all the customers that has delegates some role to this customer.",
- "httpMethod": "GET",
- "parameterOrder": [
- "partnerId"
- ],
- "response": {
- "$ref": "ListCustomersResponse"
- },
- "parameters": {
- "partnerId": {
- "description": "the id of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/partners/{partnersId}/customers",
- "path": "v1/partners/{+partnerId}/customers",
- "id": "androiddeviceprovisioning.partners.customers.list"
+ "$ref": "FindDevicesByOwnerRequest"
+ }
}
}
}
@@ -313,31 +305,21 @@
}
},
"parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
- "location": "query"
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
"location": "query",
@@ -345,24 +327,25 @@
"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",
- "location": "query"
+ "type": "string"
},
"alt": {
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -375,8 +358,7 @@
"json",
"media",
"proto"
- ],
- "type": "string"
+ ]
},
"access_token": {
"location": "query",
@@ -384,244 +366,63 @@
"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"
},
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
"pp": {
"location": "query",
"description": "Pretty-print response.",
"default": "true",
"type": "boolean"
+ },
+ "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": {
- "DeviceClaim": {
- "properties": {
- "ownerCompanyId": {
- "format": "int64",
- "description": "owner id",
- "type": "string"
- },
- "sectionType": {
- "enumDescriptions": [
- "Unspecified",
- "Zero touch"
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "section type.",
- "type": "string"
- }
- },
- "id": "DeviceClaim",
- "description": "containing the necessary info about a claim for a partner.",
- "type": "object"
- },
- "DevicesLongRunningOperationResponse": {
- "description": "Long running operation response.",
- "type": "object",
- "properties": {
- "successCount": {
- "format": "int32",
- "description": "Number of succeesfully processed ones.",
- "type": "integer"
- },
- "perDeviceStatus": {
- "items": {
- "$ref": "OperationPerDevice"
- },
- "type": "array",
- "description": "processing status for each device.\nOne PerDeviceStatus per device. The order is the same as in your requests."
- }
- },
- "id": "DevicesLongRunningOperationResponse"
- },
- "PerDeviceStatusInBatch": {
- "description": "Stores the processing result for each device.",
- "type": "object",
- "properties": {
- "errorMessage": {
- "description": "Error message",
- "type": "string"
- },
- "deviceId": {
- "format": "int64",
- "description": "device id of the device if process succeeds.",
- "type": "string"
- },
- "status": {
- "description": "Process result.",
- "type": "string",
- "enumDescriptions": [
- "Invalid code. Shouldn' be used.",
- "Unknown error.\nUnknown error is we don't expect it here.",
- "Other error.\nOther error is we know/expect this error, but not having proper error\ncode yet.",
- "Success.",
- "Permission denied",
- "Invalid device identifier.",
- "Invalid section type.",
- "This section is claimed by other company."
- ],
- "enum": [
- "SINGLE_DEVICE_STATUS_UNSPECIFIED",
- "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR",
- "SINGLE_DEVICE_STATUS_OTHER_ERROR",
- "SINGLE_DEVICE_STATUS_SUCCESS",
- "SINGLE_DEVICE_STATUS_PERMISSION_DENIED",
- "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER",
- "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
- "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS"
- ]
- },
- "errorIdentifier": {
- "description": "Error identifier.",
- "type": "string"
- }
- },
- "id": "PerDeviceStatusInBatch"
- },
- "ClaimDevicesRequest": {
- "properties": {
- "claims": {
- "description": "list of claims.",
- "items": {
- "$ref": "PartnerClaim"
- },
- "type": "array"
- }
- },
- "id": "ClaimDevicesRequest",
- "description": "Request to claim devices asynchronously in batch.",
- "type": "object"
- },
- "FindDevicesByOwnerRequest": {
- "description": "Request to find devices by customers.",
- "type": "object",
- "properties": {
- "sectionType": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified",
- "Zero touch"
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "The section type."
- },
- "pageToken": {
- "description": "Page token",
- "type": "string"
- },
- "customerId": {
- "description": "List of customer ids to search for.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "limit": {
- "format": "int64",
- "description": "The number of devices to show in the result.",
- "type": "string"
- }
- },
- "id": "FindDevicesByOwnerRequest"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "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": "This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "DeviceIdentifier": {
- "description": "DeviceIdentifiers identifies an unique device.",
- "type": "object",
- "properties": {
- "serialNumber": {
- "description": "Serial number (optional)",
- "type": "string"
- },
- "imei": {
- "description": "IMEI",
- "type": "string"
- },
- "manufacturer": {
- "description": "Manufacturer name to match `android.os.Build.MANUFACTURER` (required).\nAllowed values listed in\n[manufacturer names](/zero-touch/resources/manufacturer-names).",
- "type": "string"
- },
- "meid": {
- "type": "string",
- "description": "MEID"
- }
- },
- "id": "DeviceIdentifier"
- },
"UnclaimDevicesRequest": {
- "description": "Request to unclaim devices asynchronously in batch.",
- "type": "object",
"properties": {
"unclaims": {
- "description": "list of unclaims.",
"items": {
"$ref": "PartnerUnclaim"
},
- "type": "array"
+ "type": "array",
+ "description": "list of unclaims."
}
},
- "id": "UnclaimDevicesRequest"
+ "id": "UnclaimDevicesRequest",
+ "description": "Request to unclaim devices asynchronously in batch.",
+ "type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
+ "type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
- },
- "type": "object"
+ }
},
"type": "array"
},
@@ -629,10 +430,6 @@
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
}
},
"id": "Status"
@@ -651,8 +448,8 @@
"$ref": "DeviceIdentifier"
},
"pageToken": {
- "description": "Page token",
- "type": "string"
+ "type": "string",
+ "description": "Page token"
}
},
"id": "FindDevicesByDeviceIdentifierRequest"
@@ -662,20 +459,20 @@
"type": "object",
"properties": {
"updateMetadata": {
- "$ref": "UpdateMetadataArguments",
- "description": "Request to set metadata for a device."
+ "description": "Request to set metadata for a device.",
+ "$ref": "UpdateMetadataArguments"
},
"result": {
- "$ref": "PerDeviceStatusInBatch",
- "description": "Processing result for every device."
+ "description": "Processing result for every device.",
+ "$ref": "PerDeviceStatusInBatch"
},
"unclaim": {
- "$ref": "PartnerUnclaim",
- "description": "Request to unclaim a device."
+ "description": "Request to unclaim a device.",
+ "$ref": "PartnerUnclaim"
},
"claim": {
- "$ref": "PartnerClaim",
- "description": "Request to claim a device."
+ "description": "Request to claim a device.",
+ "$ref": "PartnerClaim"
}
},
"id": "OperationPerDevice"
@@ -684,50 +481,21 @@
"description": "Response containing found devices.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Page token of next page",
+ "type": "string"
+ },
"devices": {
"description": "Devices found.",
"items": {
"$ref": "Device"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Page token of next page",
- "type": "string"
}
},
"id": "FindDevicesByOwnerResponse"
},
- "ClaimDeviceRequest": {
- "id": "ClaimDeviceRequest",
- "description": "Request message to claim a device on behalf of a customer.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "description": "The device identifier of the device to claim.",
- "$ref": "DeviceIdentifier"
- },
- "sectionType": {
- "enumDescriptions": [
- "Unspecified",
- "Zero touch"
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "Section to claim",
- "type": "string"
- },
- "customerId": {
- "format": "int64",
- "description": "The customer to claim for.",
- "type": "string"
- }
- }
- },
"DevicesLongRunningOperationMetadata": {
- "description": "Long running operation metadata.",
"type": "object",
"properties": {
"processingStatus": {
@@ -757,10 +525,38 @@
"type": "integer"
}
},
- "id": "DevicesLongRunningOperationMetadata"
+ "id": "DevicesLongRunningOperationMetadata",
+ "description": "Long running operation metadata."
+ },
+ "ClaimDeviceRequest": {
+ "properties": {
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified",
+ "Zero touch"
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "Section to claim",
+ "type": "string"
+ },
+ "customerId": {
+ "format": "int64",
+ "description": "The customer to claim for.",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "The device identifier of the device to claim."
+ }
+ },
+ "id": "ClaimDeviceRequest",
+ "description": "Request message to claim a device on behalf of a customer.",
+ "type": "object"
},
"UpdateDeviceMetadataInBatchRequest": {
- "id": "UpdateDeviceMetadataInBatchRequest",
"description": "Request to update device metadata in batch.",
"type": "object",
"properties": {
@@ -771,7 +567,8 @@
},
"type": "array"
}
- }
+ },
+ "id": "UpdateDeviceMetadataInBatchRequest"
},
"ClaimDeviceResponse": {
"description": "Response message containing device id of the claim.",
@@ -782,15 +579,14 @@
"type": "string"
},
"deviceId": {
- "type": "string",
"format": "int64",
- "description": "the device id of the claimed device."
+ "description": "the device id of the claimed device.",
+ "type": "string"
}
},
"id": "ClaimDeviceResponse"
},
"ListCustomersResponse": {
- "description": "Response message of all customers related to this partner.",
"type": "object",
"properties": {
"customers": {
@@ -801,29 +597,31 @@
"type": "array"
}
},
- "id": "ListCustomersResponse"
+ "id": "ListCustomersResponse",
+ "description": "Response message of all customers related to this partner."
},
"UpdateMetadataArguments": {
+ "id": "UpdateMetadataArguments",
"description": "Identifies metdata updates to one device.",
"type": "object",
"properties": {
+ "deviceMetadata": {
+ "description": "The metadata to update.",
+ "$ref": "DeviceMetadata"
+ },
+ "deviceIdentifier": {
+ "description": "device identifier.",
+ "$ref": "DeviceIdentifier"
+ },
"deviceId": {
"format": "int64",
"description": "device id of the device.",
"type": "string"
- },
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "The metadata to update."
- },
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "device identifier."
}
- },
- "id": "UpdateMetadataArguments"
+ }
},
"Device": {
+ "description": "Device",
"type": "object",
"properties": {
"claims": {
@@ -834,8 +632,8 @@
"type": "array"
},
"deviceIdentifier": {
- "description": "Device identifier",
- "$ref": "DeviceIdentifier"
+ "$ref": "DeviceIdentifier",
+ "description": "Device identifier"
},
"deviceMetadata": {
"description": "Device metadata",
@@ -851,15 +649,13 @@
"type": "string"
},
"configuration": {
- "description": "The resource name of the configuration.\nOnly set for customers.",
- "type": "string"
+ "type": "string",
+ "description": "The resource name of the configuration.\nOnly set for customers."
}
},
- "id": "Device",
- "description": "Device"
+ "id": "Device"
},
"Company": {
- "description": "Company",
"type": "object",
"properties": {
"ownerEmails": {
@@ -890,85 +686,31 @@
"type": "string"
}
},
- "id": "Company"
+ "id": "Company",
+ "description": "Company"
},
"UpdateDeviceMetadataRequest": {
+ "description": "Request to set metadata for a device.",
+ "type": "object",
"properties": {
"deviceMetadata": {
"$ref": "DeviceMetadata",
"description": "The metdata to set."
}
},
- "id": "UpdateDeviceMetadataRequest",
- "description": "Request to set metadata for a device.",
- "type": "object"
+ "id": "UpdateDeviceMetadataRequest"
},
"PartnerUnclaim": {
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "description": "device identifier of the device.",
- "$ref": "DeviceIdentifier"
- },
- "sectionType": {
- "enumDescriptions": [
- "Unspecified",
- "Zero touch"
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "section type to unclaim.",
- "type": "string"
- },
- "deviceId": {
- "format": "int64",
- "description": "device id of the device.",
- "type": "string"
- }
- },
"id": "PartnerUnclaim",
- "description": "Identifies one unclaim request."
- },
- "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"
- },
- "FindDevicesByDeviceIdentifierResponse": {
- "description": "Response containing found devices.",
+ "description": "Identifies one unclaim request.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Page token of next page",
- "type": "string"
- },
- "devices": {
- "description": "Found devices.",
- "items": {
- "$ref": "Device"
- },
- "type": "array"
- }
- },
- "id": "FindDevicesByDeviceIdentifierResponse"
- },
- "PartnerClaim": {
- "description": "Identifies one claim request.",
- "type": "object",
- "properties": {
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "metadata to set at claim."
- },
"deviceIdentifier": {
"$ref": "DeviceIdentifier",
- "description": "Device identifier of the device."
+ "description": "device identifier of the device."
},
"sectionType": {
- "description": "section type to claim.",
+ "description": "section type to unclaim.",
"type": "string",
"enumDescriptions": [
"Unspecified",
@@ -979,10 +721,65 @@
"SECTION_TYPE_ZERO_TOUCH"
]
},
+ "deviceId": {
+ "format": "int64",
+ "description": "device id of the device.",
+ "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 `{}`."
+ },
+ "FindDevicesByDeviceIdentifierResponse": {
+ "description": "Response containing found devices.",
+ "type": "object",
+ "properties": {
+ "devices": {
+ "description": "Found devices.",
+ "items": {
+ "$ref": "Device"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Page token of next page",
+ "type": "string"
+ }
+ },
+ "id": "FindDevicesByDeviceIdentifierResponse"
+ },
+ "PartnerClaim": {
+ "description": "Identifies one claim request.",
+ "type": "object",
+ "properties": {
+ "sectionType": {
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "section type to claim.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified",
+ "Zero touch"
+ ]
+ },
"customerId": {
"format": "int64",
"description": "customer id to claim for.",
"type": "string"
+ },
+ "deviceMetadata": {
+ "description": "metadata to set at claim.",
+ "$ref": "DeviceMetadata"
+ },
+ "deviceIdentifier": {
+ "description": "Device identifier of the device.",
+ "$ref": "DeviceIdentifier"
}
},
"id": "PartnerClaim"
@@ -991,16 +788,143 @@
"description": "Request message to unclaim a device.",
"type": "object",
"properties": {
- "deviceId": {
- "format": "int64",
- "description": "The device id returned by ClaimDevice.",
- "type": "string"
- },
"deviceIdentifier": {
"$ref": "DeviceIdentifier",
"description": "The device identifier you use when you claimed this device."
},
"sectionType": {
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "The section type to unclaim for.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified",
+ "Zero touch"
+ ]
+ },
+ "deviceId": {
+ "format": "int64",
+ "description": "The device id returned by ClaimDevice.",
+ "type": "string"
+ }
+ },
+ "id": "UnclaimDeviceRequest"
+ },
+ "DeviceMetadata": {
+ "id": "DeviceMetadata",
+ "description": "A key value pair of the device metadata.",
+ "type": "object",
+ "properties": {
+ "entries": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata entries",
+ "type": "object"
+ }
+ }
+ },
+ "DeviceClaim": {
+ "description": "containing the necessary info about a claim for a partner.",
+ "type": "object",
+ "properties": {
+ "sectionType": {
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "section type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified",
+ "Zero touch"
+ ]
+ },
+ "ownerCompanyId": {
+ "format": "int64",
+ "description": "owner id",
+ "type": "string"
+ }
+ },
+ "id": "DeviceClaim"
+ },
+ "DevicesLongRunningOperationResponse": {
+ "description": "Long running operation response.",
+ "type": "object",
+ "properties": {
+ "successCount": {
+ "format": "int32",
+ "description": "Number of succeesfully processed ones.",
+ "type": "integer"
+ },
+ "perDeviceStatus": {
+ "description": "processing status for each device.\nOne PerDeviceStatus per device. The order is the same as in your requests.",
+ "items": {
+ "$ref": "OperationPerDevice"
+ },
+ "type": "array"
+ }
+ },
+ "id": "DevicesLongRunningOperationResponse"
+ },
+ "PerDeviceStatusInBatch": {
+ "description": "Stores the processing result for each device.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Process result.",
+ "type": "string",
+ "enumDescriptions": [
+ "Invalid code. Shouldn' be used.",
+ "Unknown error.\nUnknown error is we don't expect it here.",
+ "Other error.\nOther error is we know/expect this error, but not having proper error\ncode yet.",
+ "Success.",
+ "Permission denied",
+ "Invalid device identifier.",
+ "Invalid section type.",
+ "This section is claimed by other company."
+ ],
+ "enum": [
+ "SINGLE_DEVICE_STATUS_UNSPECIFIED",
+ "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR",
+ "SINGLE_DEVICE_STATUS_OTHER_ERROR",
+ "SINGLE_DEVICE_STATUS_SUCCESS",
+ "SINGLE_DEVICE_STATUS_PERMISSION_DENIED",
+ "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER",
+ "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
+ "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS"
+ ]
+ },
+ "errorIdentifier": {
+ "description": "Error identifier.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "Error message",
+ "type": "string"
+ },
+ "deviceId": {
+ "format": "int64",
+ "description": "device id of the device if process succeeds.",
+ "type": "string"
+ }
+ },
+ "id": "PerDeviceStatusInBatch"
+ },
+ "FindDevicesByOwnerRequest": {
+ "description": "Request to find devices by customers.",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "format": "int64",
+ "description": "The number of devices to show in the result.",
+ "type": "string"
+ },
+ "sectionType": {
+ "description": "The section type.",
+ "type": "string",
"enumDescriptions": [
"Unspecified",
"Zero touch"
@@ -1008,26 +932,94 @@
"enum": [
"SECTION_TYPE_UNSPECIFIED",
"SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "The section type to unclaim for.",
+ ]
+ },
+ "pageToken": {
+ "description": "Page token",
"type": "string"
- }
- },
- "id": "UnclaimDeviceRequest"
- },
- "DeviceMetadata": {
- "properties": {
- "entries": {
- "description": "Metadata entries",
- "type": "object",
- "additionalProperties": {
+ },
+ "customerId": {
+ "description": "List of customer ids to search for.",
+ "items": {
+ "format": "int64",
"type": "string"
- }
+ },
+ "type": "array"
}
},
- "id": "DeviceMetadata",
- "description": "A key value pair of the device metadata.",
- "type": "object"
+ "id": "FindDevicesByOwnerRequest"
+ },
+ "ClaimDevicesRequest": {
+ "description": "Request to claim devices asynchronously in batch.",
+ "type": "object",
+ "properties": {
+ "claims": {
+ "description": "list of claims.",
+ "items": {
+ "$ref": "PartnerClaim"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ClaimDevicesRequest"
+ },
+ "DeviceIdentifier": {
+ "description": "DeviceIdentifiers identifies an unique device.",
+ "type": "object",
+ "properties": {
+ "serialNumber": {
+ "description": "Serial number (optional)",
+ "type": "string"
+ },
+ "imei": {
+ "description": "IMEI",
+ "type": "string"
+ },
+ "manufacturer": {
+ "type": "string",
+ "description": "Manufacturer name to match `android.os.Build.MANUFACTURER` (required).\nAllowed values listed in\n[manufacturer names](/zero-touch/resources/manufacturer-names)."
+ },
+ "meid": {
+ "type": "string",
+ "description": "MEID"
+ }
+ },
+ "id": "DeviceIdentifier"
+ },
+ "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": "This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
+ "type": "object"
+ }
+ },
+ "id": "Operation"
}
},
"icons": {
@@ -1038,8 +1030,16 @@
"version": "v1",
"baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
"canonicalName": "Android Provisioning Partner",
- "kind": "discovery#restDescription",
- "description": "Automates reseller integration into Zero Touch Provisioning by assigning devices to customers and creating device reports.",
"servicePath": "",
- "rootUrl": "https://androiddeviceprovisioning.googleapis.com/"
+ "description": "Automates reseller integration into Zero Touch Provisioning by assigning devices to customers and creating device reports.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "androiddeviceprovisioning",
+ "batchPath": "batch",
+ "revision": "20170819",
+ "documentationLink": "https://developers.google.com/zero-touch/",
+ "id": "androiddeviceprovisioning:v1",
+ "title": "Android Device Provisioning Partner API"
}
diff --git a/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json
index 36d8216..ce4264f 100644
--- a/appengine/v1/appengine-api.json
+++ b/appengine/v1/appengine-api.json
@@ -1,49 +1,71 @@
{
+ "version": "v1",
+ "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"
}
}
}
},
- "kind": "discovery#restDescription",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"servicePath": "",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "kind": "discovery#restDescription",
"rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
- "id": "appengine:v1",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170811",
+ "id": "appengine:v1",
+ "revision": "20170823",
"title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
"apps": {
"methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps",
+ "path": "v1/apps",
+ "id": "appengine.apps.create",
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "request": {
+ "$ref": "Application"
+ }
+ },
"repair": {
+ "id": "appengine.apps.repair",
+ "path": "v1/apps/{appsId}:repair",
"request": {
"$ref": "RepairApplicationRequest"
},
"description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -55,9 +77,7 @@
"location": "path"
}
},
- "flatPath": "v1/apps/{appsId}:repair",
- "path": "v1/apps/{appsId}:repair",
- "id": "appengine.apps.repair"
+ "flatPath": "v1/apps/{appsId}:repair"
},
"patch": {
"httpMethod": "PATCH",
@@ -67,9 +87,6 @@
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"updateMask": {
"format": "google-fieldmask",
@@ -78,31 +95,35 @@
"location": "query"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/apps/{appsId}",
"path": "v1/apps/{appsId}",
"id": "appengine.apps.patch",
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
"request": {
"$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application."
+ }
},
"get": {
- "path": "v1/apps/{appsId}",
+ "flatPath": "v1/apps/{appsId}",
"id": "appengine.apps.get",
+ "path": "v1/apps/{appsId}",
"description": "Gets information about an application.",
+ "parameterOrder": [
+ "appsId"
+ ],
"httpMethod": "GET",
"response": {
"$ref": "Application"
},
- "parameterOrder": [
- "appsId"
- ],
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
@@ -110,37 +131,594 @@
],
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp."
}
- },
- "flatPath": "v1/apps/{appsId}"
- },
- "create": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "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/).",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
+ }
}
},
"resources": {
+ "services": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete",
+ "description": "Deletes the specified service and all enclosed versions.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "patch": {
+ "id": "appengine.apps.services.patch",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "migrateTraffic": {
+ "location": "query",
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "type": "boolean"
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}"
+ },
+ "get": {
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.get",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "description": "Gets the current configuration of the specified service."
+ },
+ "list": {
+ "description": "Lists all the services in the application.",
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page."
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
+ "path": "v1/apps/{appsId}/services"
+ }
+ },
+ "resources": {
+ "versions": {
+ "methods": {
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment."
+ },
+ "get": {
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Version"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.get"
+ },
+ "list": {
+ "id": "appengine.apps.services.versions.list",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "description": "Lists the versions of a service.",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page."
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string",
+ "location": "query"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions"
+ },
+ "create": {
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Deploys code and resource files to a new version.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions"
+ },
+ "delete": {
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "description": "Deletes an existing Version resource.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "get": {
+ "description": "Gets instance information.",
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.get",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
+ },
+ "list": {
+ "id": "appengine.apps.services.versions.instances.list",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "versionsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`."
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
+ },
+ "debug": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ }
+ },
+ "delete": {
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.delete",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Stops a running instance.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1."
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"operations": {
"methods": {
"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.",
"httpMethod": "GET",
"parameterOrder": [
@@ -150,6 +728,11 @@
"response": {
"$ref": "Operation"
},
+ "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": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -158,29 +741,28 @@
"location": "path"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. The name of the operation resource.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/operations/{operationsId}",
- "path": "v1/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
+ "flatPath": "v1/apps/{appsId}/operations/{operationsId}"
},
"list": {
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"filter": {
"location": "query",
@@ -205,52 +787,46 @@
"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",
- "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."
+ "id": "appengine.apps.operations.list"
}
}
},
"locations": {
"methods": {
"get": {
- "description": "Get information about a location.",
- "httpMethod": "GET",
+ "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`.",
+ "appsId": {
"type": "string",
"required": true,
- "location": "path"
- },
- "appsId": {
"location": "path",
- "description": "Part of `name`. Resource name for the location.",
+ "description": "Part of `name`. Resource name for the location."
+ },
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true
}
},
"flatPath": "v1/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
"path": "v1/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
+ "description": "Get information about a location."
},
"list": {
"httpMethod": "GET",
@@ -266,11 +842,6 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
"pageToken": {
"description": "The standard list page token.",
"type": "string",
@@ -283,10 +854,15 @@
"required": true
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "The standard list page size.",
- "type": "integer",
- "location": "query"
+ "type": "integer"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
}
},
"flatPath": "v1/apps/{appsId}/locations",
@@ -295,585 +871,21 @@
"description": "Lists information about the supported locations for this service."
}
}
- },
- "services": {
- "methods": {
- "delete": {
- "flatPath": "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- }
- }
- },
- "patch": {
- "description": "Updates the configuration of the specified service.",
- "request": {
- "$ref": "Service"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- },
- "migrateTraffic": {
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch"
- },
- "get": {
- "description": "Gets the current configuration of the specified service.",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Service"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get",
- "path": "v1/apps/{appsId}/services/{servicesId}"
- },
- "list": {
- "description": "Lists all the services in the application.",
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page."
- }
- },
- "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",
- "id": "appengine.apps.services.list",
- "path": "v1/apps/{appsId}/services"
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions",
- "description": "Deploys code and resource files to a new version.",
- "request": {
- "$ref": "Version"
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
- "description": "Deletes an existing Version resource."
- },
- "patch": {
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch",
- "request": {
- "$ref": "Version"
- },
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "view": {
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get"
- },
- "list": {
- "description": "Lists the versions of a service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "view": {
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response."
- },
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list"
- }
- },
- "resources": {
- "instances": {
- "methods": {
- "delete": {
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "description": "Stops a running instance.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
- },
- "get": {
- "id": "appengine.apps.services.versions.instances.get",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information.",
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
- },
- "list": {
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "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)."
- },
- "debug": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "instancesId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "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",
- "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."
- }
- }
- }
- }
- }
- }
}
}
}
},
"parameters": {
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -885,35 +897,37 @@
"default": "true",
"type": "boolean"
},
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
+ "location": "query",
+ "description": "Data format for response.",
"default": "json",
"enum": [
"json",
@@ -925,19 +939,17 @@
"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": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"location": "query",
@@ -949,868 +961,11 @@
"type": "boolean",
"location": "query",
"description": "Pretty-print response."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
}
},
"schemas": {
- "LivenessCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object",
- "properties": {
- "path": {
- "type": "string",
- "description": "The request path."
- },
- "successThreshold": {
- "type": "integer",
- "format": "uint32",
- "description": "Number of consecutive successful checks required before considering the VM healthy."
- },
- "host": {
- "type": "string",
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\""
- },
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- },
- "failureThreshold": {
- "type": "integer",
- "format": "uint32",
- "description": "Number of consecutive failed checks required before considering the VM unhealthy."
- },
- "timeout": {
- "format": "google-duration",
- "description": "Time before the check is considered failed.",
- "type": "string"
- },
- "initialDelay": {
- "format": "google-duration",
- "description": "The initial delay before starting to execute the checks.",
- "type": "string"
- }
- },
- "id": "LivenessCheck"
- },
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReceivedPacketsPerSecond": {
- "format": "int32",
- "description": "Target packets received per second.",
- "type": "integer"
- },
- "targetSentBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes sent per second.",
- "type": "integer"
- },
- "targetReceivedBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes received per second.",
- "type": "integer"
- },
- "targetSentPacketsPerSecond": {
- "format": "int32",
- "description": "Target packets sent per second.",
- "type": "integer"
- }
- },
- "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": {
- "format": "google-duration",
- "description": "Time before the health check is considered failed.",
- "type": "string"
- },
- "unhealthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "healthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "type": "integer"
- },
- "restartThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "type": "integer"
- },
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- }
- },
- "id": "HealthCheck"
- },
- "ReadinessCheck": {
- "type": "object",
- "properties": {
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- },
- "failureThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed checks required before removing traffic.",
- "type": "integer"
- },
- "timeout": {
- "type": "string",
- "format": "google-duration",
- "description": "Time before the check is considered failed."
- },
- "appStartTimeout": {
- "format": "google-duration",
- "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
- "type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- },
- "successThreshold": {
- "format": "uint32",
- "description": "Number of consecutive successful checks required before receiving traffic.",
- "type": "integer"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- }
- },
- "id": "ReadinessCheck",
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation."
- },
- "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": {
- "id": "OperationMetadataV1Beta5",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Timestamp that this operation completed.@OutputOnly"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- }
- }
- },
- "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",
- "properties": {
- "readinessCheck": {
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.",
- "$ref": "ReadinessCheck"
- },
- "manualScaling": {
- "$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": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
- },
- "endpointsApiService": {
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
- "$ref": "EndpointsApiService"
- },
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
- "type": "string"
- },
- "instanceClass": {
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
- "type": "string"
- },
- "servingStatus": {
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ],
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ],
- "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING."
- },
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
- },
- "runtimeApiVersion": {
- "type": "string",
- "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"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Time that this version was created.@OutputOnly",
- "type": "string"
- },
- "inboundServices": {
- "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"
- },
- "type": "array",
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ],
- "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service."
- },
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "ErrorHandler"
- },
- "type": "array"
- },
- "defaultExpiration": {
- "format": "google-duration",
- "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "libraries": {
- "items": {
- "$ref": "Library"
- },
- "type": "array",
- "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set."
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "basicScaling": {
- "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": {
- "type": "string",
- "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\"."
- },
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "envVariables": {
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "livenessCheck": {
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
- "$ref": "LivenessCheck"
- },
- "network": {
- "description": "Extra network settings. Only applicable for App Engine flexible environment versions.",
- "$ref": "Network"
- },
- "betaSettings": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata settings that are supplied to this version to enable beta runtime features."
- },
- "env": {
- "description": "App Engine execution environment for this version.Defaults to standard.",
- "type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "UrlMap"
- },
- "type": "array"
- },
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "diskUsageBytes": {
- "format": "int64",
- "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
- "type": "string"
- },
- "healthCheck": {
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
- "$ref": "HealthCheck"
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- }
- }
- },
- "RepairApplicationRequest": {
- "description": "Request message for 'Applications.RepairApplication'.",
- "type": "object",
- "properties": {},
- "id": "RepairApplicationRequest"
- },
- "ScriptHandler": {
- "id": "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"
- }
- }
- },
- "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"
- },
- "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": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataExperimental"
- },
- "TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
- "type": "object",
- "properties": {
- "allocations": {
- "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."
- },
- "shardBy": {
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
- "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
- ],
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP",
- "RANDOM"
- ],
- "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
- "type": "string"
- }
- },
- "id": "TrafficSplit"
- },
- "OperationMetadataV1Beta": {
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "ListServicesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "services": {
- "description": "The services belonging to the requested application.",
- "items": {
- "$ref": "Service"
- },
- "type": "array"
- }
- },
- "id": "ListServicesResponse",
- "description": "Response message for Services.ListServices.",
- "type": "object"
- },
- "Deployment": {
- "id": "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."
- },
- "container": {
- "$ref": "ContainerInfo",
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
- },
- "files": {
- "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."
- }
- }
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "volumes": {
- "description": "User specified volumes.",
- "items": {
- "$ref": "Volume"
- },
- "type": "array"
- },
- "diskGb": {
- "format": "double",
- "description": "Disk size (GB) needed.",
- "type": "number"
- },
- "memoryGb": {
- "format": "double",
- "description": "Memory (GB) needed.",
- "type": "number"
- },
- "cpu": {
- "format": "double",
- "description": "Number of CPU cores needed.",
- "type": "number"
- }
- },
- "id": "Resources"
- },
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "sizeGb": {
- "format": "double",
- "description": "Volume size in gigabytes.",
- "type": "number"
- },
- "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": {
- "type": "string",
- "description": "Continuation token for fetching the next page of results."
- },
- "instances": {
- "description": "The instances belonging to the requested version.",
- "items": {
- "$ref": "Instance"
- },
- "type": "array"
- }
- },
- "id": "ListInstancesResponse"
- },
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "type": "string",
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Alpha"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- },
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
- "items": {
- "$ref": "Version"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse"
- },
- "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": {
- "id": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
- "properties": {
- "minPendingLatency": {
- "format": "google-duration",
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- },
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "maxIdleInstances": {
- "format": "int32",
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "type": "integer"
- },
- "minIdleInstances": {
- "format": "int32",
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
- "type": "integer"
- },
- "maxTotalInstances": {
- "format": "int32",
- "description": "Maximum number of instances that should be started to handle requests.",
- "type": "integer"
- },
- "minTotalInstances": {
- "format": "int32",
- "description": "Minimum number of instances that should be maintained for this version.",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "coolDownPeriod": {
- "type": "string",
- "format": "google-duration",
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes."
- },
- "maxConcurrentRequests": {
- "format": "int32",
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "type": "integer"
- },
- "maxPendingLatency": {
- "format": "google-duration",
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- }
- }
- },
- "ZipInfo": {
- "description": "The zip file information for a zip deployment.",
- "type": "object",
- "properties": {
- "filesCount": {
- "format": "int32",
- "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
- "type": "integer"
- },
- "sourceUrl": {
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- }
- },
- "id": "ZipInfo"
- },
- "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.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
- }
- },
- "id": "ListLocationsResponse"
- },
"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",
"properties": {
@@ -1818,8 +973,7 @@
"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.",
@@ -1839,7 +993,23 @@
"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": {
+ "authFailAction": {
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ]
+ },
"script": {
"$ref": "ScriptHandler",
"description": "Executes a script to handle the request that matches this URL pattern."
@@ -1849,6 +1019,12 @@
"type": "string"
},
"login": {
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
"description": "Level of login required to access this resource.",
"type": "string",
"enumDescriptions": [
@@ -1856,12 +1032,6 @@
"Does not require that the user is signed in.",
"If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
"If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
]
},
"apiEndpoint": {
@@ -1873,6 +1043,13 @@
"$ref": "StaticFilesHandler"
},
"redirectHttpResponseCode": {
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ],
"enum": [
"REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
"REDIRECT_HTTP_RESPONSE_CODE_301",
@@ -1881,14 +1058,105 @@
"REDIRECT_HTTP_RESPONSE_CODE_307"
],
"description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string",
+ "type": "string"
+ },
+ "securityLevel": {
"enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ]
+ "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"
+ }
+ },
+ "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": {
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "type": "string"
+ },
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ }
+ },
+ "id": "EndpointsApiService"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
+ "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"
+ }
+ },
+ "id": "Operation"
+ },
+ "ApiConfigHandler": {
+ "type": "object",
+ "properties": {
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ },
+ "login": {
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
},
"securityLevel": {
"description": "Security (HTTPS) enforcement for this URL.",
@@ -1909,139 +1177,31 @@
]
},
"authFailAction": {
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "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."
- }
- },
- "id": "UrlMap",
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object"
- },
- "EndpointsApiService": {
- "id": "EndpointsApiService",
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
- "properties": {
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "type": "string"
- },
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- }
- }
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "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"
- },
- "securityLevel": {
- "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"
- ],
- "description": "Security (HTTPS) enforcement for this URL."
- },
- "authFailAction": {
"description": "Action to take when users access resources that require authentication. Defaults to redirect.",
"type": "string",
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
"Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
"Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
]
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
}
},
- "id": "ApiConfigHandler"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "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"
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers."
},
"StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "type": "object",
"properties": {
+ "requireMatchingFile": {
+ "type": "boolean",
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist."
+ },
"expiration": {
"format": "google-duration",
"description": "Time a static file served by this handler should be cached by web proxies and browsers.",
@@ -2069,15 +1229,26 @@
"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",
- "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"
+ "id": "StaticFilesHandler"
+ },
+ "BasicScaling": {
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "type": "object",
+ "properties": {
+ "maxInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances to create for this version.",
+ "type": "integer"
+ },
+ "idleTimeout": {
+ "format": "google-duration",
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "type": "string"
+ }
+ },
+ "id": "BasicScaling"
},
"DiskUtilization": {
"description": "Target scaling by disk usage. Only applicable for VM runtimes.",
@@ -2099,33 +1270,14 @@
"type": "integer"
},
"targetWriteOpsPerSecond": {
+ "type": "integer",
"format": "int32",
- "description": "Target ops written per second.",
- "type": "integer"
+ "description": "Target ops written per second."
}
},
"id": "DiskUtilization"
},
- "BasicScaling": {
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "type": "object",
- "properties": {
- "maxInstances": {
- "type": "integer",
- "format": "int32",
- "description": "Maximum number of instances to create for this version."
- },
- "idleTimeout": {
- "format": "google-duration",
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "type": "string"
- }
- },
- "id": "BasicScaling"
- },
"CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
"properties": {
"aggregationWindowLength": {
"format": "google-duration",
@@ -2133,28 +1285,19 @@
"type": "string"
},
"targetUtilization": {
+ "type": "number",
"format": "double",
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "type": "number"
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1."
}
},
- "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 that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- },
"code": {
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
@@ -2163,6 +1306,17 @@
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
}
},
"id": "Status"
@@ -2191,6 +1345,7 @@
"id": "IdentityAwareProxy"
},
"ManualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
"type": "object",
"properties": {
"instances": {
@@ -2199,23 +1354,22 @@
"type": "integer"
}
},
- "id": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ "id": "ManualScaling"
},
"LocationMetadata": {
- "id": "LocationMetadata",
"description": "Metadata for the given google.cloud.location.Location.",
"type": "object",
"properties": {
- "standardEnvironmentAvailable": {
- "type": "boolean",
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly"
- },
"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.",
@@ -2226,38 +1380,42 @@
"type": "string"
},
"split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
- "$ref": "TrafficSplit"
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
},
"id": {
- "type": "string",
- "description": "Relative name of the service within the application. Example: default.@OutputOnly"
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
}
},
"id": "Service"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
- "type": "array",
- "description": "A list of operations that matches the specified filter in the request."
+ "type": "array"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "The standard List next-page token."
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "type": "string"
+ },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
@@ -2267,8 +1425,8 @@
"type": "string"
},
"method": {
- "type": "string",
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly"
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
},
"endTime": {
"format": "google-datetime",
@@ -2278,17 +1436,23 @@
"operationType": {
"description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
"type": "string"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
}
},
- "id": "OperationMetadata"
+ "id": "OperationMetadata",
+ "description": "Metadata for the given google.longrunning.Operation."
+ },
+ "FeatureSettings": {
+ "properties": {
+ "splitHealthChecks": {
+ "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.",
+ "type": "boolean"
+ }
+ },
+ "id": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
+ "type": "object"
},
"ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
"type": "object",
"properties": {
"mimeType": {
@@ -2314,36 +1478,17 @@
"type": "string"
},
"staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
+ "type": "string",
+ "description": "Static file content to be served for this error."
}
},
- "id": "ErrorHandler"
+ "id": "ErrorHandler",
+ "description": "Custom static error page to be served when an error occurs."
},
"OperationMetadataV1": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
@@ -2356,6 +1501,26 @@
"format": "google-datetime",
"description": "Time that this operation completed.@OutputOnly",
"type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly"
}
},
"id": "OperationMetadataV1"
@@ -2364,29 +1529,11 @@
"description": "An Application resource contains the top-level configuration of an App Engine application. Next tag: 20",
"type": "object",
"properties": {
- "gcrDomain": {
- "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "format": "google-duration",
- "description": "Cookie expiration policy for this application.",
- "type": "string"
- },
"locationId": {
"type": "string",
"description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US"
},
"servingStatus": {
- "description": "Serving status of this application.",
"type": "string",
"enumDescriptions": [
"Serving status is unspecified.",
@@ -2399,19 +1546,24 @@
"SERVING",
"USER_DISABLED",
"SYSTEM_DISABLED"
- ]
+ ],
+ "description": "Serving status of this application."
},
"defaultHostname": {
"description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
"type": "string"
},
- "iap": {
- "$ref": "IdentityAwareProxy"
+ "featureSettings": {
+ "$ref": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application."
},
"authDomain": {
"description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
"type": "string"
},
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
"codeBucket": {
"description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
"type": "string"
@@ -2426,6 +1578,23 @@
"$ref": "UrlDispatchRule"
},
"type": "array"
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "format": "google-duration",
+ "description": "Cookie expiration policy for this application.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
}
},
"id": "Application"
@@ -2443,11 +1612,11 @@
"type": "string"
},
"forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable for App Engine flexible environment versions.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable for App Engine flexible environment versions."
+ "type": "array"
},
"name": {
"description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
@@ -2465,8 +1634,8 @@
"description": "Average latency (ms) over the last minute.@OutputOnly",
"type": "integer"
},
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
"memoryUsage": {
@@ -2474,32 +1643,32 @@
"description": "Total memory in use (bytes).@OutputOnly",
"type": "string"
},
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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"
+ "errors": {
+ "format": "int32",
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "type": "integer"
},
"availability": {
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
"description": "Availability of the instance.@OutputOnly",
"type": "string",
"enumDescriptions": [
"",
"",
""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
]
},
- "errors": {
- "format": "int32",
- "description": "Number of errors since this instance was started.@OutputOnly",
- "type": "integer"
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
},
"startTime": {
"format": "google-datetime",
@@ -2542,13 +1711,859 @@
}
},
"id": "Instance"
+ },
+ "LivenessCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
+ "type": "object",
+ "properties": {
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the check is considered failed.",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy."
+ },
+ "initialDelay": {
+ "format": "google-duration",
+ "description": "The initial delay before starting to execute the checks.",
+ "type": "string"
+ },
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ },
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "successThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "format": "google-duration",
+ "description": "Interval between health checks.",
+ "type": "string"
+ }
+ },
+ "id": "LivenessCheck"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReceivedBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes received per second.",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSecond": {
+ "format": "int32",
+ "description": "Target packets sent per second.",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "format": "int32",
+ "description": "Target packets received per second.",
+ "type": "integer"
+ },
+ "targetSentBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes sent per second.",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization"
+ },
+ "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": {
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the health check is considered failed.",
+ "type": "string"
+ },
+ "unhealthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "type": "integer"
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "restartThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "type": "integer"
+ },
+ "healthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "Interval between health checks."
+ }
+ },
+ "id": "HealthCheck"
+ },
+ "ReadinessCheck": {
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "format": "uint32",
+ "description": "Number of consecutive successful checks required before receiving traffic.",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "format": "google-duration",
+ "description": "Interval between health checks.",
+ "type": "string"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the check is considered failed.",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "type": "integer"
+ },
+ "appStartTimeout": {
+ "format": "google-duration",
+ "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
+ "type": "string"
+ }
+ },
+ "id": "ReadinessCheck"
+ },
+ "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": {
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta5",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "Version": {
+ "properties": {
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
+ },
+ "diskUsageBytes": {
+ "format": "int64",
+ "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
+ "type": "string"
+ },
+ "healthCheck": {
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "readinessCheck": {
+ "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.",
+ "$ref": "ReadinessCheck"
+ },
+ "manualScaling": {
+ "$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."
+ },
+ "endpointsApiService": {
+ "$ref": "EndpointsApiService",
+ "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
+ },
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "type": "string"
+ },
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
+ "type": "string"
+ },
+ "servingStatus": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ],
+ "enum": [
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING",
+ "STOPPED"
+ ],
+ "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
+ "type": "string"
+ },
+ "deployment": {
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
+ "$ref": "Deployment"
+ },
+ "runtimeApiVersion": {
+ "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
+ "type": "string"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Time that this version was created.@OutputOnly",
+ "type": "string"
+ },
+ "resources": {
+ "description": "Machine resources for this version. Only applicable for VM runtimes.",
+ "$ref": "Resources"
+ },
+ "inboundServices": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ],
+ "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
+ "items": {
+ "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"
+ },
+ "type": "array"
+ },
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "ErrorHandler"
+ },
+ "type": "array"
+ },
+ "defaultExpiration": {
+ "format": "google-duration",
+ "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "libraries": {
+ "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "Library"
+ },
+ "type": "array"
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "basicScaling": {
+ "$ref": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
+ },
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\"."
+ },
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
+ },
+ "livenessCheck": {
+ "$ref": "LivenessCheck",
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
+ },
+ "network": {
+ "description": "Extra network settings. Only applicable for App Engine flexible environment versions.",
+ "$ref": "Network"
+ },
+ "betaSettings": {
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "env": {
+ "description": "App Engine execution environment for this version.Defaults to standard.",
+ "type": "string"
+ },
+ "handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "UrlMap"
+ },
+ "type": "array"
+ }
+ },
+ "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'.",
+ "type": "object",
+ "properties": {},
+ "id": "RepairApplicationRequest"
+ },
+ "FileInfo": {
+ "type": "object",
+ "properties": {
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "mimeType": {
+ "type": "string",
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage."
+ },
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "id": "FileInfo",
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately."
+ },
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ScriptHandler"
+ },
+ "OperationMetadataExperimental": {
+ "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": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataExperimental"
+ },
+ "TrafficSplit": {
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "type": "object",
+ "properties": {
+ "allocations": {
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "shardBy": {
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP",
+ "RANDOM"
+ ],
+ "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
+ "type": "string",
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
+ "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
+ ]
+ }
+ },
+ "id": "TrafficSplit"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Durable messages that persist on every operation poll. @OutputOnly"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "type": "string",
+ "description": "User who requested this operation.@OutputOnly"
+ },
+ "target": {
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListServicesResponse"
+ },
+ "Resources": {
+ "properties": {
+ "volumes": {
+ "description": "User specified volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ },
+ "diskGb": {
+ "format": "double",
+ "description": "Disk size (GB) needed.",
+ "type": "number"
+ },
+ "memoryGb": {
+ "format": "double",
+ "description": "Memory (GB) needed.",
+ "type": "number"
+ },
+ "cpu": {
+ "format": "double",
+ "description": "Number of CPU cores needed.",
+ "type": "number"
+ }
+ },
+ "id": "Resources",
+ "description": "Machine resources for a version.",
+ "type": "object"
+ },
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object",
+ "properties": {
+ "files": {
+ "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"
+ }
+ },
+ "zip": {
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
+ },
+ "container": {
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
+ "$ref": "ContainerInfo"
+ }
+ },
+ "id": "Deployment"
+ },
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "sizeGb": {
+ "format": "double",
+ "description": "Volume size in gigabytes.",
+ "type": "number"
+ },
+ "name": {
+ "description": "Unique name for the volume.",
+ "type": "string"
+ },
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ }
+ },
+ "id": "Volume"
+ },
+ "ListInstancesResponse": {
+ "id": "ListInstancesResponse",
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object",
+ "properties": {
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationMetadataV1Alpha": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Alpha",
+ "description": "Metadata for the given google.longrunning.Operation."
+ },
+ "UrlDispatchRule": {
+ "type": "object",
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters."
+ },
+ "service": {
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule",
+ "description": "Rules to match an HTTP request and dispatch that request to a service."
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
+ "properties": {
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListVersionsResponse"
+ },
+ "ApiEndpointHandler": {
+ "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": {
+ "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": {
+ "format": "int32",
+ "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
+ "type": "integer"
+ }
+ },
+ "id": "ZipInfo"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object",
+ "properties": {
+ "minTotalInstances": {
+ "format": "int32",
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "maxConcurrentRequests": {
+ "format": "int32",
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "type": "integer"
+ },
+ "coolDownPeriod": {
+ "format": "google-duration",
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "type": "string"
+ },
+ "maxPendingLatency": {
+ "format": "google-duration",
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "$ref": "CpuUtilization"
+ },
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "minPendingLatency": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it."
+ },
+ "maxIdleInstances": {
+ "format": "int32",
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "type": "integer"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "minIdleInstances": {
+ "format": "int32",
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "type": "integer"
+ }
+ },
+ "id": "AutomaticScaling"
+ },
+ "Library": {
+ "properties": {
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the library. Example: \"django\"."
+ }
+ },
+ "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.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListLocationsResponse"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "version": "v1",
- "baseUrl": "https://appengine.googleapis.com/"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ }
}
diff --git a/appengine/v1/appengine-gen.go b/appengine/v1/appengine-gen.go
index 4de32bf..80fb860 100644
--- a/appengine/v1/appengine-gen.go
+++ b/appengine/v1/appengine-gen.go
@@ -291,6 +291,10 @@
// supported.@OutputOnly
DispatchRules []*UrlDispatchRule `json:"dispatchRules,omitempty"`
+ // FeatureSettings: The feature specific settings to be used in the
+ // application.
+ FeatureSettings *FeatureSettings `json:"featureSettings,omitempty"`
+
// GcrDomain: The Google Container Registry domain used for storing
// managed build docker images for this application.
GcrDomain string `json:"gcrDomain,omitempty"`
@@ -740,6 +744,41 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// FeatureSettings: The feature specific settings to be used in the
+// application. These define behaviors that are user configurable.
+type FeatureSettings struct {
+ // SplitHealthChecks: Boolean value indicating if split health checks
+ // should be used instead of the legacy health checks. At an app.yaml
+ // level, this means defaulting to 'readiness_check' and
+ // 'liveness_check' values instead of 'health_check' ones. Once the
+ // legacy 'health_check' behavior is deprecated, and this value is
+ // always true, this setting can be removed.
+ SplitHealthChecks bool `json:"splitHealthChecks,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "SplitHealthChecks")
+ // 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. "SplitHealthChecks") 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 *FeatureSettings) MarshalJSON() ([]byte, error) {
+ type noMethod FeatureSettings
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// FileInfo: Single source file that is part of the version to be
// deployed. Each source file that is deployed must be specified
// separately.
@@ -5306,6 +5345,27 @@
// pps.services.versions#Version.FIELDS.automatic_scaling): For Version
// resources that use automatic scaling and run in the App Engine
// standard environment.
+// automatic_scaling.min_total_instances
+// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/a
+// pps.services.versions#Version.FIELDS.automatic_scaling): For Version
+// resources that use automatic scaling and run in the App Engine
+// Flexible environment.
+// automatic_scaling.max_total_instances
+// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/a
+// pps.services.versions#Version.FIELDS.automatic_scaling): For Version
+// resources that use automatic scaling and run in the App Engine
+// Flexible environment.
+// automatic_scaling.cool_down_period_sec
+// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/a
+// pps.services.versions#Version.FIELDS.automatic_scaling): For Version
+// resources that use automatic scaling and run in the App Engine
+// Flexible
+// environment.
+// automatic_scaling.cpu_utilization.target_utilization
+// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/a
+// pps.services.versions#Version.FIELDS.automatic_scaling): For Version
+// resources that use automatic scaling and run in the App Engine
+// Flexible environment.
func (r *AppsServicesVersionsService) Patch(appsId string, servicesId string, versionsId string, version *Version) *AppsServicesVersionsPatchCall {
c := &AppsServicesVersionsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -5410,7 +5470,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
// "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
// "httpMethod": "PATCH",
// "id": "appengine.apps.services.versions.patch",
diff --git a/appengine/v1alpha/appengine-api.json b/appengine/v1alpha/appengine-api.json
index 1d9489b..5c4c929 100644
--- a/appengine/v1alpha/appengine-api.json
+++ b/appengine/v1alpha/appengine-api.json
@@ -1,74 +1,44 @@
{
+ "servicePath": "",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://appengine.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "appengine",
+ "batchPath": "batch",
+ "id": "appengine:v1alpha",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "revision": "20170823",
"title": "Google App Engine Admin API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"apps": {
"resources": {
- "authorizedDomains": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list",
- "path": "v1alpha/apps/{appsId}/authorizedDomains",
- "description": "Lists all domains the user is authorized to administer."
- }
- }
- },
"operations": {
"methods": {
"get": {
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"operationsId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "GET",
"parameters": {
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
"appsId": {
"description": "Part of `name`. The name of the operation resource.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
@@ -77,8 +47,8 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
- "path": "v1alpha/apps/{appsId}/operations/{operationsId}",
"id": "appengine.apps.operations.get",
+ "path": "v1alpha/apps/{appsId}/operations/{operationsId}",
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
},
"list": {
@@ -95,27 +65,27 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
"pageToken": {
+ "type": "string",
"location": "query",
- "description": "The standard list page token.",
- "type": "string"
+ "description": "The standard list page token."
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. The name of the operation's parent resource.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "The standard list page size.",
- "type": "integer",
- "location": "query"
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
}
},
"flatPath": "v1alpha/apps/{appsId}/operations",
@@ -129,36 +99,36 @@
"methods": {
"get": {
"flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
"id": "appengine.apps.locations.get",
+ "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
"description": "Get information about a location.",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Location"
+ },
"parameterOrder": [
"appsId",
"locationsId"
],
- "response": {
- "$ref": "Location"
- },
- "parameters": {
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "type": "string",
- "required": true
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
},
"list": {
"description": "Lists information about the supported locations for this service.",
@@ -175,27 +145,27 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
"filter": {
+ "location": "query",
"description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
"type": "string",
"location": "query"
},
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
"appsId": {
+ "location": "path",
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
+ "required": true
}
},
"flatPath": "v1alpha/apps/{appsId}/locations",
@@ -206,38 +176,14 @@
},
"domainMappings": {
"methods": {
- "delete": {
+ "patch": {
"flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
"path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete",
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "response": {
- "$ref": "Operation"
+ "id": "appengine.apps.domainMappings.patch",
+ "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
+ "request": {
+ "$ref": "DomainMapping"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true
- },
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- }
- },
- "patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"appsId",
@@ -246,22 +192,7 @@
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true
- },
"domainMappingsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
@@ -272,18 +203,25 @@
"location": "query",
"description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.",
"type": "boolean"
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true
}
},
- "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch",
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"get": {
- "description": "Gets the specified domain mapping.",
"response": {
"$ref": "DomainMapping"
},
@@ -292,53 +230,37 @@
"domainMappingsId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
"type": "string",
- "required": true
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
"required": true,
"location": "path"
+ },
+ "domainMappingsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
"id": "appengine.apps.domainMappings.get",
- "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}"
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "description": "Gets the specified domain mapping."
},
"list": {
- "flatPath": "v1alpha/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "path": "v1alpha/apps/{appsId}/domainMappings",
- "description": "Lists the domain mappings on an application.",
- "response": {
- "$ref": "ListDomainMappingsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
"pageToken": {
"location": "query",
"description": "Continuation token for fetching the next page of results.",
@@ -349,62 +271,147 @@
"type": "string",
"required": true,
"location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
}
+ },
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings",
+ "path": "v1alpha/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.list",
+ "description": "Lists the domain mappings on an application.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
}
},
"create": {
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "noManagedCertificate": {
+ "location": "query",
+ "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings",
+ "path": "v1alpha/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
"request": {
"$ref": "DomainMapping"
},
- "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"
+ }
+ },
+ "delete": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [
- "appsId"
+ "appsId",
+ "domainMappingsId"
],
- "httpMethod": "POST",
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "noManagedCertificate": {
- "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.",
- "type": "boolean",
- "location": "query"
- },
"appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "domainMappingsId": {
"location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true
}
},
- "flatPath": "v1alpha/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
- "path": "v1alpha/apps/{appsId}/domainMappings"
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.delete",
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource."
}
}
},
"authorizedCertificates": {
"methods": {
- "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"
- },
+ "delete": {
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "description": "Deletes the specified SSL certificate.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"appsId",
"authorizedCertificatesId"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "type": "string",
+ "required": true
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ },
+ "patch": {
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.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"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"parameters": {
+ "authorizedCertificatesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
"updateMask": {
"location": "query",
"format": "google-fieldmask",
@@ -416,22 +423,13 @@
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
"type": "string",
"required": true
- },
- "authorizedCertificatesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
}
},
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"get": {
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
"description": "Gets the specified SSL certificate.",
"httpMethod": "GET",
"parameterOrder": [
@@ -442,38 +440,38 @@
"$ref": "AuthorizedCertificate"
},
"parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "type": "string",
- "required": true
- },
"view": {
- "description": "Controls the set of fields returned in the GET response.",
- "type": "string",
"location": "query",
"enum": [
"BASIC_CERTIFICATE",
"FULL_CERTIFICATE"
- ]
+ ],
+ "description": "Controls the set of fields returned in the GET response.",
+ "type": "string"
},
"authorizedCertificatesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345."
}
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get"
},
"list": {
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates",
"description": "Lists all SSL certificates the user is authorized to administer.",
"response": {
"$ref": "ListAuthorizedCertificatesResponse"
@@ -488,39 +486,38 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the LIST response.",
- "type": "string"
- },
"pageToken": {
"location": "query",
"description": "Continuation token for fetching the next page of results.",
"type": "string"
},
"appsId": {
+ "location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the LIST response.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ]
}
- }
+ },
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates"
},
"create": {
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate.",
"response": {
"$ref": "AuthorizedCertificate"
},
@@ -528,51 +525,65 @@
"appsId"
],
"httpMethod": "POST",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "description": "Uploads the specified SSL certificate.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ }
+ }
+ }
+ },
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "description": "Lists all domains the user is authorized to administer.",
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
"parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
"appsId": {
"location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"type": "string",
"required": true
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates"
- },
- "delete": {
- "description": "Deletes the specified SSL certificate.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "type": "string",
- "required": true
},
- "authorizedCertificatesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ "flatPath": "v1alpha/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list",
+ "path": "v1alpha/apps/{appsId}/authorizedDomains"
}
}
}
@@ -580,11 +591,22 @@
}
},
"parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
"location": "query"
},
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
@@ -601,16 +623,16 @@
"type": "boolean",
"location": "query"
},
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
@@ -630,6 +652,7 @@
"type": "string"
},
"alt": {
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -642,8 +665,7 @@
"json",
"media",
"proto"
- ],
- "type": "string"
+ ]
},
"access_token": {
"description": "OAuth access token.",
@@ -651,54 +673,204 @@
"location": "query"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
}
},
"schemas": {
- "AuthorizedCertificate": {
- "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
+ "AuthorizedDomain": {
+ "properties": {
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizedDomain",
+ "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
+ "type": "object"
+ },
+ "ListAuthorizedDomainsResponse": {
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
"type": "object",
"properties": {
- "domainMappingsCount": {
- "format": "int32",
- "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
- "type": "integer"
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
},
- "domainNames": {
- "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListAuthorizedDomainsResponse"
+ },
+ "Status": {
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
+ "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"
+ },
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "type": "object",
+ "properties": {
+ "sslSettings": {
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
+ "$ref": "SslSettings"
+ },
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "resourceRecords": {
+ "items": {
+ "$ref": "ResourceRecord"
+ },
+ "type": "array",
+ "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly"
+ },
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
+ "type": "string"
+ }
+ },
+ "id": "DomainMapping"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "OperationMetadataV1Beta": {
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
"type": "string"
},
"type": "array"
},
- "id": {
- "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
"type": "string"
},
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "type": "string",
+ "description": "User who requested this operation.@OutputOnly"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta",
+ "description": "Metadata for the given google.longrunning.Operation."
+ },
+ "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": {
+ "type": "string",
+ "description": "The canonical id for this location. For example: \"us-east1\"."
+ },
+ "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",
+ "description": "A resource that represents Google Cloud Platform location."
+ },
+ "AuthorizedCertificate": {
+ "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
+ "type": "object",
+ "properties": {
"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"
+ "$ref": "CertificateRawData",
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
},
"managedCertificate": {
- "$ref": "ManagedCertificate",
- "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly"
+ "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly",
+ "$ref": "ManagedCertificate"
},
"visibleDomainMappings": {
"description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
@@ -715,6 +887,22 @@
"name": {
"description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
"type": "string"
+ },
+ "domainMappingsCount": {
+ "format": "int32",
+ "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
+ "type": "integer"
+ },
+ "domainNames": {
+ "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "type": "string"
}
},
"id": "AuthorizedCertificate"
@@ -723,48 +911,48 @@
"description": "A DNS resource record.",
"type": "object",
"properties": {
+ "name": {
+ "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "type": "string"
+ },
"type": {
- "enumDescriptions": [
- "An A resource record. Data is an IPv4 address.",
- "An AAAA resource record. Data is an IPv6 address.",
- "A CNAME resource record. Data is a domain name to be aliased."
- ],
"enum": [
"A",
"AAAA",
"CNAME"
],
"description": "Resource record type. Example: AAAA.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "An A resource record. Data is an IPv4 address.",
+ "An AAAA resource record. Data is an IPv6 address.",
+ "A CNAME resource record. Data is a domain name to be aliased."
+ ]
},
"rrdata": {
"description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
"type": "string"
- },
- "name": {
- "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
- "type": "string"
}
},
"id": "ResourceRecord"
},
"ListOperationsResponse": {
+ "id": "ListOperationsResponse",
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
}
- },
- "id": "ListOperationsResponse"
+ }
},
"OperationMetadata": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -775,26 +963,26 @@
"description": "Timestamp that this operation was created.@OutputOnly",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
"type": "string"
},
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
"type": "string"
},
"endTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "Timestamp that this operation completed.@OutputOnly",
- "type": "string"
+ "description": "Timestamp that this operation completed.@OutputOnly"
},
"operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly"
}
},
"id": "OperationMetadata"
@@ -803,16 +991,16 @@
"description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
"certificates": {
"description": "The SSL certificates the user is authorized to administer.",
"items": {
"$ref": "AuthorizedCertificate"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
"id": "ListAuthorizedCertificatesResponse"
@@ -821,6 +1009,10 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
"insertTime": {
"format": "google-datetime",
"description": "Timestamp that this operation was created.@OutputOnly",
@@ -838,10 +1030,6 @@
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
- },
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
}
},
"id": "OperationMetadataV1Beta5"
@@ -850,28 +1038,29 @@
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListLocationsResponse"
},
"ManagedCertificate": {
+ "id": "ManagedCertificate",
"description": "A certificate managed by App Engine.",
"type": "object",
"properties": {
"lastRenewalTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly",
- "type": "string"
+ "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly"
},
"status": {
"description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
@@ -893,8 +1082,37 @@
"FAILED_PERMANENTLY_NOT_VISIBLE"
]
}
+ }
+ },
+ "CertificateRawData": {
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "type": "object",
+ "properties": {
+ "privateKey": {
+ "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
+ "type": "string"
+ },
+ "publicCertificate": {
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
+ "type": "string"
+ }
},
- "id": "ManagedCertificate"
+ "id": "CertificateRawData"
+ },
+ "SslSettings": {
+ "properties": {
+ "isManagedCertificate": {
+ "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly",
+ "type": "boolean"
+ },
+ "certificateId": {
+ "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
+ "type": "string"
+ }
+ },
+ "id": "SslSettings",
+ "description": "SSL configuration for a DomainMapping resource.",
+ "type": "object"
},
"OperationMetadataV1": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -908,18 +1126,18 @@
"type": "array"
},
"insertTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
+ "description": "Time that this operation was created.@OutputOnly"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
"type": "string"
},
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/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"
@@ -936,70 +1154,40 @@
},
"id": "OperationMetadataV1"
},
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "isManagedCertificate": {
- "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly",
- "type": "boolean"
- },
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
- "type": "string"
- }
- },
- "id": "SslSettings"
- },
- "CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
- "properties": {
- "privateKey": {
- "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
- "type": "string"
- },
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
- "type": "string"
- }
- },
- "id": "CertificateRawData"
- },
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
"response": {
"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"
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
}
},
"name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the 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 originally returns it. If you use the default HTTP mapping, the 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": {
- "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"
- }
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "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."
+ },
+ "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."
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call."
},
"ListDomainMappingsResponse": {
"description": "Response message for DomainMappings.ListDomainMappings.",
@@ -1019,10 +1207,37 @@
},
"id": "ListDomainMappingsResponse"
},
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
+ "OperationMetadataExperimental": {
"type": "object",
"properties": {
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataExperimental",
+ "description": "Metadata for the given google.longrunning.Operation."
+ },
+ "OperationMetadataV1Alpha": {
+ "properties": {
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
@@ -1057,246 +1272,31 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Alpha"
- },
- "OperationMetadataExperimental": {
+ "id": "OperationMetadataV1Alpha",
"description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataExperimental"
- },
- "Status": {
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "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"
- },
- "AuthorizedDomain": {
- "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
- "type": "string"
- }
- },
- "id": "AuthorizedDomain"
- },
- "ListAuthorizedDomainsResponse": {
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "items": {
- "$ref": "AuthorizedDomain"
- },
- "type": "array"
- }
- },
- "id": "ListAuthorizedDomainsResponse"
- },
- "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"
- },
- "DomainMapping": {
- "description": "A domain serving an App Engine application.",
- "type": "object",
- "properties": {
- "resourceRecords": {
- "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
- "items": {
- "$ref": "ResourceRecord"
- },
- "type": "array"
- },
- "id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
- "type": "string"
- },
- "sslSettings": {
- "$ref": "SslSettings",
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
- },
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- }
- },
- "id": "DomainMapping"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- },
- "labels": {
- "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"
+ "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": "v1alpha",
"baseUrl": "https://appengine.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/appengine.admin": {
"description": "View and manage your applications deployed on Google App Engine"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
}
}
}
- },
- "kind": "discovery#restDescription",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "servicePath": "",
- "rootUrl": "https://appengine.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "appengine",
- "batchPath": "batch",
- "id": "appengine:v1alpha",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170811"
+ }
}
diff --git a/appengine/v1beta/appengine-api.json b/appengine/v1beta/appengine-api.json
index 25a65ed..0b8e34d 100644
--- a/appengine/v1beta/appengine-api.json
+++ b/appengine/v1beta/appengine-api.json
@@ -1,35 +1,24 @@
{
- "rootUrl": "https://appengine.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "appengine",
"batchPath": "batch",
- "revision": "20170811",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"id": "appengine:v1beta",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "revision": "20170823",
"title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"apps": {
"methods": {
"repair": {
- "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",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"flatPath": "v1beta/apps/{appsId}:repair",
@@ -38,42 +27,53 @@
"request": {
"$ref": "RepairApplicationRequest"
},
- "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account."
- },
- "patch": {
- "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"
- },
- "response": {
- "$ref": "Operation"
- },
+ "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
+ "httpMethod": "POST",
"parameterOrder": [
"appsId"
],
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "patch": {
"httpMethod": "PATCH",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- }
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta/apps/{appsId}"
+ "parameters": {
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated."
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}",
+ "path": "v1beta/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "request": {
+ "$ref": "Application"
+ },
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application."
},
"get": {
+ "flatPath": "v1beta/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1beta/apps/{appsId}",
+ "description": "Gets information about an application.",
"response": {
"$ref": "Application"
},
@@ -81,256 +81,44 @@
"appsId"
],
"httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1beta/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1beta/apps/{appsId}",
- "description": "Gets information about an application."
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ }
+ }
},
"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"
],
+ "parameters": {},
"flatPath": "v1beta/apps",
"path": "v1beta/apps",
- "id": "appengine.apps.create",
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
- "request": {
- "$ref": "Application"
- }
+ "id": "appengine.apps.create"
}
},
"resources": {
- "firewall": {
- "resources": {
- "ingressRules": {
- "methods": {
- "get": {
- "description": "Gets the specified firewall rule.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "response": {
- "$ref": "FirewallRule"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "ingressRulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get"
- },
- "patch": {
- "description": "Updates the specified firewall rule.",
- "request": {
- "$ref": "FirewallRule"
- },
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated."
- },
- "appsId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100."
- },
- "ingressRulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.patch",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
- },
- "batchUpdate": {
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "id": "appengine.apps.firewall.ingressRules.batchUpdate",
- "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.",
- "request": {
- "$ref": "BatchUpdateIngressRulesRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "BatchUpdateIngressRulesResponse"
- },
- "parameters": {
- "appsId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "description": "Deletes the specified firewall rule.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100."
- },
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.delete",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
- },
- "list": {
- "description": "Lists the firewall rules of an application.",
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
- "matchingAddress": {
- "location": "query",
- "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.list",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "FirewallRule"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.create",
- "description": "Creates a firewall rule for the application.",
- "request": {
- "$ref": "FirewallRule"
- }
- }
- }
- }
- }
- },
"locations": {
"methods": {
"get": {
- "httpMethod": "GET",
+ "description": "Get information about a location.",
"response": {
"$ref": "Location"
},
@@ -338,11 +126,7 @@
"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"
- ],
+ "httpMethod": "GET",
"parameters": {
"appsId": {
"description": "Part of `name`. Resource name for the location.",
@@ -351,29 +135,30 @@
"location": "path"
},
"locationsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
- "path": "v1beta/apps/{appsId}/locations/{locationsId}",
"id": "appengine.apps.locations.get",
- "description": "Get information about a location."
+ "path": "v1beta/apps/{appsId}/locations/{locationsId}"
},
"list": {
- "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.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListLocationsResponse"
},
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
"parameters": {
"pageToken": {
"description": "The standard list page token.",
@@ -381,40 +166,37 @@
"location": "query"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"pageSize": {
- "type": "integer",
- "location": "query",
"format": "int32",
- "description": "The standard list page size."
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
},
"filter": {
+ "location": "query",
"description": "The standard list filter.",
- "type": "string",
- "location": "query"
+ "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",
+ "path": "v1beta/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list"
}
}
},
"authorizedCertificates": {
"methods": {
"create": {
- "id": "appengine.apps.authorizedCertificates.create",
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
- "description": "Uploads the specified SSL certificate.",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
"response": {
"$ref": "AuthorizedCertificate"
},
@@ -424,22 +206,24 @@
"httpMethod": "POST",
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates"
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "description": "Uploads the specified SSL certificate.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ }
},
"delete": {
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "description": "Deletes the specified SSL certificate.",
"httpMethod": "DELETE",
"parameterOrder": [
"appsId",
@@ -452,70 +236,40 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "authorizedCertificatesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
"appsId": {
"location": "path",
"description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
"type": "string",
"required": true
+ },
+ "authorizedCertificatesId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
}
- }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "description": "Deletes the specified SSL certificate."
},
"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"
},
- "httpMethod": "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.",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"parameterOrder": [
"appsId",
"authorizedCertificatesId"
],
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameters": {
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
+ "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch"
- },
- "get": {
- "description": "Gets the specified SSL certificate.",
- "httpMethod": "GET",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
"parameters": {
"authorizedCertificatesId": {
"location": "path",
@@ -523,12 +277,42 @@
"type": "string",
"required": true
},
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "type": "string"
+ },
"appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
"type": "string",
"required": true,
- "location": "path"
- },
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345."
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.patch",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ },
+ "get": {
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "description": "Gets the specified SSL certificate.",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
"view": {
"location": "query",
"enum": [
@@ -537,48 +321,33 @@
],
"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"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListAuthorizedCertificatesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
},
- "appsId": {
+ "authorizedCertificatesId": {
"location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true
},
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page."
- },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "list": {
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "description": "Lists all SSL certificates the user is authorized to administer.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListAuthorizedCertificatesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
"view": {
"location": "query",
"enum": [
@@ -587,50 +356,53 @@
],
"description": "Controls the set of fields returned in the LIST response.",
"type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results."
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
}
},
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "description": "Lists all SSL certificates the user is authorized to administer."
+ "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"
}
}
},
"services": {
"methods": {
- "delete": {
- "id": "appengine.apps.services.delete",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "description": "Deletes the specified service and all enclosed versions.",
- "response": {
- "$ref": "Operation"
+ "patch": {
+ "request": {
+ "$ref": "Service"
},
+ "description": "Updates the configuration of the specified service.",
+ "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"servicesId"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}"
- },
- "patch": {
- "parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
"type": "string",
@@ -655,41 +427,30 @@
"required": true
}
},
- "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}",
- "description": "Updates the configuration of the specified service.",
- "request": {
- "$ref": "Service"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "PATCH"
+ "id": "appengine.apps.services.patch"
},
"get": {
- "description": "Gets the current configuration of the specified service.",
"response": {
"$ref": "Service"
},
+ "httpMethod": "GET",
"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`.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"appsId": {
"location": "path",
@@ -698,282 +459,86 @@
"required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
"id": "appengine.apps.services.get",
- "path": "v1beta/apps/{appsId}/services/{servicesId}"
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "description": "Gets the current configuration of the specified service."
},
"list": {
"description": "Lists all the services in the application.",
- "response": {
- "$ref": "ListServicesResponse"
- },
"parameterOrder": [
"appsId"
],
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
"httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page."
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "flatPath": "v1beta/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
+ "path": "v1beta/apps/{appsId}/services"
+ },
+ "delete": {
+ "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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
"appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true,
"location": "path"
}
- },
- "flatPath": "v1beta/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
- "path": "v1beta/apps/{appsId}/services"
+ }
}
},
"resources": {
"versions": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Deletes an existing Version resource."
- },
- "patch": {
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch",
- "request": {
- "$ref": "Version"
- },
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true
- },
- "view": {
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get"
- },
- "list": {
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "view": {
- "description": "Controls the set of fields returned in the List response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "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."
- },
- "create": {
- "parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "Operation"
- }
- }
- },
"resources": {
"instances": {
"methods": {
- "debug": {
+ "delete": {
"response": {
"$ref": "Operation"
},
@@ -983,55 +548,7 @@
"versionsId",
"instancesId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1."
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment."
- },
- "delete": {
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
"httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -1043,10 +560,10 @@
"location": "path"
},
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"instancesId": {
"location": "path",
@@ -1055,10 +572,10 @@
"required": true
},
"appsId": {
- "type": "string",
- "required": true,
"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`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true
}
},
"flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
@@ -1067,16 +584,17 @@
"description": "Stops a running instance."
},
"get": {
- "response": {
- "$ref": "Instance"
- },
+ "description": "Gets instance information.",
+ "httpMethod": "GET",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId",
"instancesId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Instance"
+ },
"parameters": {
"versionsId": {
"location": "path",
@@ -1109,38 +627,35 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get",
"path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information."
+ "id": "appengine.apps.services.versions.instances.get"
},
"list": {
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
"httpMethod": "GET",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "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": {
- "versionsId": {
+ "servicesId": {
"location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
"type": "string",
"required": true
},
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"appsId": {
"location": "path",
@@ -1153,19 +668,292 @@
"format": "int32",
"description": "Maximum results to return per page.",
"type": "integer"
+ },
+ "versionsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
"path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list"
+ "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)."
+ },
+ "debug": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1."
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment."
}
}
}
+ },
+ "methods": {
+ "delete": {
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete",
+ "description": "Deletes an existing Version resource.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ },
+ "patch": {
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch",
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
+ "request": {
+ "$ref": "Version"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated."
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "type": "string",
+ "required": true
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Version"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.get",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page."
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list",
+ "description": "Lists the versions of a service."
+ },
+ "create": {
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "description": "Deploys code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
}
}
}
@@ -1173,13 +961,16 @@
"authorizedDomains": {
"methods": {
"list": {
+ "path": "v1beta/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list",
+ "description": "Lists all domains the user is authorized to administer.",
"httpMethod": "GET",
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
"parameterOrder": [
"appsId"
],
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
@@ -1187,15 +978,15 @@
],
"parameters": {
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"type": "string",
"required": true,
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp."
+ "location": "path"
},
"pageSize": {
"format": "int32",
@@ -1204,10 +995,7 @@
"location": "query"
}
},
- "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."
+ "flatPath": "v1beta/apps/{appsId}/authorizedDomains"
}
}
},
@@ -1228,17 +1016,17 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation resource.",
- "type": "string",
- "required": true
- },
"operationsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
"flatPath": "v1beta/apps/{appsId}/operations/{operationsId}",
@@ -1257,26 +1045,26 @@
"httpMethod": "GET",
"parameters": {
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
"type": "string",
"location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
}
},
"scopes": [
@@ -1292,6 +1080,33 @@
},
"domainMappings": {
"methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/domainMappings",
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
+ "request": {
+ "$ref": "DomainMapping"
+ }
+ },
"delete": {
"response": {
"$ref": "Operation"
@@ -1301,6 +1116,9 @@
"domainMappingsId"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
@@ -1309,39 +1127,27 @@
"location": "path"
},
"domainMappingsId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
"id": "appengine.apps.domainMappings.delete",
"path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
"description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource."
},
"patch": {
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"domainMappingsId"
],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "PATCH",
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true,
- "location": "path"
- },
"domainMappingsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
@@ -1349,42 +1155,50 @@
"location": "path"
},
"updateMask": {
- "type": "string",
"location": "query",
"format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated."
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true
}
},
+ "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",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
"request": {
"$ref": "DomainMapping"
- },
- "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource."
+ }
},
"get": {
- "description": "Gets the specified domain mapping.",
+ "response": {
+ "$ref": "DomainMapping"
+ },
"httpMethod": "GET",
"parameterOrder": [
"appsId",
"domainMappingsId"
],
- "response": {
- "$ref": "DomainMapping"
- },
"parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
"domainMappingsId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true
}
},
"scopes": [
@@ -1393,132 +1207,299 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get",
"path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get"
+ "description": "Gets the specified domain mapping."
},
"list": {
+ "flatPath": "v1beta/apps/{appsId}/domainMappings",
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.list",
+ "description": "Lists the domain mappings on an application.",
"httpMethod": "GET",
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
+ },
"parameterOrder": [
"appsId"
],
- "response": {
- "$ref": "ListDomainMappingsResponse"
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results."
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "description": "Lists the domain mappings on an application."
- },
- "create": {
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "request": {
- "$ref": "DomainMapping"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
]
}
}
+ },
+ "firewall": {
+ "resources": {
+ "ingressRules": {
+ "methods": {
+ "batchUpdate": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "id": "appengine.apps.firewall.ingressRules.batchUpdate",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "request": {
+ "$ref": "BatchUpdateIngressRulesRequest"
+ },
+ "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.",
+ "response": {
+ "$ref": "BatchUpdateIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST"
+ },
+ "delete": {
+ "description": "Deletes the specified firewall rule.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "parameters": {
+ "matchingAddress": {
+ "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.list",
+ "description": "Lists the firewall rules of an application."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.create",
+ "description": "Creates a firewall rule for the application.",
+ "request": {
+ "$ref": "FirewallRule"
+ }
+ },
+ "get": {
+ "description": "Gets the specified firewall rule.",
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.get",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
+ },
+ "patch": {
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.patch",
+ "description": "Updates the specified firewall rule.",
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
}
}
}
},
"parameters": {
- "key": {
+ "oauth_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 2.0 token for the current user.",
"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": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
"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"
+ "type": "string"
},
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "type": "boolean"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
+ "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -1528,21 +1509,9 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format."
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ ]
},
"alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -1550,27 +1519,989 @@
"media",
"proto"
],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
"type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Pretty-print response."
}
},
"schemas": {
- "ListInstancesResponse": {
+ "Network": {
+ "description": "Extra network settings. Only applicable for App Engine flexible environment versions",
+ "type": "object",
+ "properties": {
+ "subnetworkName": {
+ "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.",
+ "type": "string"
+ },
+ "instanceTag": {
+ "type": "string",
+ "description": "Tag to apply to the VM instance during creation. Only applicable for for App Engine flexible environment versions."
+ },
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable for App Engine flexible environment versions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ }
+ },
+ "id": "Network"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application. Next tag: 20",
+ "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": {
+ "enumDescriptions": [
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "SERVING",
+ "USER_DISABLED",
+ "SYSTEM_DISABLED"
+ ],
+ "description": "Serving status of this application.",
+ "type": "string"
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "featureSettings": {
+ "description": "The feature specific settings to be used in the application.",
+ "$ref": "FeatureSettings"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "authDomain": {
+ "type": "string",
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account."
+ },
+ "codeBucket": {
+ "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "type": "string",
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ },
+ "type": "array"
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "format": "google-duration",
+ "description": "Cookie expiration policy for this application.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ }
+ },
+ "id": "Application"
+ },
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object",
+ "properties": {
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "format": "float",
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "type": "number"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "format": "int32",
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "type": "integer"
+ },
+ "vmIp": {
+ "type": "string",
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly"
+ },
+ "memoryUsage": {
+ "format": "int64",
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "errors": {
+ "format": "int32",
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "type": "integer"
+ },
+ "vmStatus": {
+ "type": "string",
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly"
+ },
+ "availability": {
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Time that this instance was started.@OutputOnly",
+ "type": "string"
+ },
+ "vmDebugEnabled": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "requests": {
+ "format": "int32",
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "type": "integer"
+ }
+ },
+ "id": "Instance"
+ },
+ "LivenessCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ },
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "successThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "format": "google-duration",
+ "description": "Interval between health checks.",
+ "type": "string"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the check is considered failed.",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "type": "integer"
+ },
+ "initialDelay": {
+ "format": "google-duration",
+ "description": "The initial delay before starting to execute the checks.",
+ "type": "string"
+ }
+ },
+ "id": "LivenessCheck"
+ },
+ "BatchUpdateIngressRulesRequest": {
+ "type": "object",
+ "properties": {
+ "ingressRules": {
+ "description": "A list of FirewallRules to replace the existing set.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchUpdateIngressRulesRequest",
+ "description": "Request message for Firewall.BatchUpdateIngressRules."
+ },
+ "Location": {
+ "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": {
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetSentBytesPerSecond": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Target bytes sent per second."
+ },
+ "targetReceivedBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes received per second.",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSecond": {
+ "format": "int32",
+ "description": "Target packets sent per second.",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "format": "int32",
+ "description": "Target packets received per second.",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization"
+ },
+ "HealthCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "type": "object",
+ "properties": {
+ "unhealthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "type": "integer"
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "healthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "type": "integer"
+ },
+ "restartThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "format": "google-duration",
+ "description": "Interval between health checks.",
+ "type": "string"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the health check is considered failed.",
+ "type": "string"
+ }
+ },
+ "id": "HealthCheck"
+ },
+ "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": {
+ "format": "uint32",
+ "description": "Number of consecutive successful checks required before receiving traffic.",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "format": "google-duration",
+ "description": "Interval between health checks.",
+ "type": "string"
+ },
+ "timeout": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "Time before the check is considered failed."
+ },
+ "failureThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "type": "integer"
+ },
+ "appStartTimeout": {
+ "format": "google-duration",
+ "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
+ "type": "string"
+ },
+ "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"
+ },
+ "StandardSchedulerSettings": {
+ "properties": {
+ "maxInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances for an app version. Set to a non-positive value (0 by convention) to disable max_instances configuration.",
+ "type": "integer"
+ },
+ "minInstances": {
+ "format": "int32",
+ "description": "Minimum number of instances for an app version. Set to a non-positive value (0 by convention) to disable min_instances configuration.",
+ "type": "integer"
+ },
+ "targetCpuUtilization": {
+ "format": "double",
+ "description": "Target CPU utilization ratio to maintain when scaling.",
+ "type": "number"
+ },
+ "targetThroughputUtilization": {
+ "format": "double",
+ "description": "Target throughput utilization ratio to maintain when scaling",
+ "type": "number"
+ }
+ },
+ "id": "StandardSchedulerSettings",
+ "description": "Scheduler settings for standard environment.",
+ "type": "object"
+ },
+ "OperationMetadataV1Beta5": {
+ "type": "object",
+ "properties": {
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "Timestamp that this operation completed.@OutputOnly"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta5",
+ "description": "Metadata for the given google.longrunning.Operation."
+ },
+ "Version": {
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
+ "type": "object",
+ "properties": {
+ "errorHandlers": {
+ "items": {
+ "$ref": "ErrorHandler"
+ },
+ "type": "array",
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set."
+ },
+ "defaultExpiration": {
+ "format": "google-duration",
+ "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "libraries": {
+ "items": {
+ "$ref": "Library"
+ },
+ "type": "array",
+ "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set."
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "basicScaling": {
+ "$ref": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
+ },
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "type": "string"
+ },
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
+ },
+ "livenessCheck": {
+ "$ref": "LivenessCheck",
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
+ },
+ "network": {
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable for App Engine flexible environment versions."
+ },
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
+ },
+ "env": {
+ "description": "App Engine execution environment for this version.Defaults to standard.",
+ "type": "string"
+ },
+ "handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "UrlMap"
+ },
+ "type": "array"
+ },
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
+ },
+ "diskUsageBytes": {
+ "format": "int64",
+ "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
+ "type": "string"
+ },
+ "healthCheck": {
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
+ "$ref": "HealthCheck"
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "readinessCheck": {
+ "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.",
+ "$ref": "ReadinessCheck"
+ },
+ "manualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "$ref": "ManualScaling"
+ },
+ "name": {
+ "type": "string",
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly"
+ },
+ "apiConfig": {
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
+ },
+ "endpointsApiService": {
+ "$ref": "EndpointsApiService",
+ "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
+ },
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "type": "string"
+ },
+ "instanceClass": {
+ "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"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Time that this version was created.@OutputOnly",
+ "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.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "INBOUND_SERVICE_UNSPECIFIED",
+ "INBOUND_SERVICE_MAIL",
+ "INBOUND_SERVICE_MAIL_BOUNCE",
+ "INBOUND_SERVICE_XMPP_ERROR",
+ "INBOUND_SERVICE_XMPP_MESSAGE",
+ "INBOUND_SERVICE_XMPP_SUBSCRIBE",
+ "INBOUND_SERVICE_XMPP_PRESENCE",
+ "INBOUND_SERVICE_CHANNEL_PRESENCE",
+ "INBOUND_SERVICE_WARMUP"
+ ]
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ]
+ }
+ },
+ "id": "Version"
+ },
+ "RepairApplicationRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "RepairApplicationRequest",
+ "description": "Request message for 'Applications.RepairApplication'."
+ },
+ "CertificateRawData": {
+ "id": "CertificateRawData",
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "type": "object",
+ "properties": {
+ "privateKey": {
+ "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
+ "type": "string"
+ },
+ "publicCertificate": {
+ "type": "string",
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e"
+ }
+ }
+ },
+ "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"
+ },
+ "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": {
+ "properties": {
+ "mimeType": {
+ "type": "string",
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage."
+ },
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ },
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ }
+ },
+ "id": "FileInfo",
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "type": "object"
+ },
+ "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": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataExperimental"
+ },
+ "AuthorizedDomain": {
+ "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizedDomain"
+ },
+ "TrafficSplit": {
+ "id": "TrafficSplit",
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "type": "object",
+ "properties": {
+ "allocations": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
+ },
+ "shardBy": {
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
+ "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP",
+ "RANDOM"
+ ],
+ "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
"type": "string"
},
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListServicesResponse"
+ },
+ "ListIngressRulesResponse": {
+ "description": "Response message for Firewall.ListIngressRules.",
+ "type": "object",
+ "properties": {
+ "ingressRules": {
+ "description": "The ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListIngressRulesResponse"
+ },
+ "Resources": {
+ "description": "Machine resources for a version.",
+ "type": "object",
+ "properties": {
+ "volumes": {
+ "description": "User specified volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ },
+ "diskGb": {
+ "format": "double",
+ "description": "Disk size (GB) needed.",
+ "type": "number"
+ },
+ "memoryGb": {
+ "format": "double",
+ "description": "Memory (GB) needed.",
+ "type": "number"
+ },
+ "cpu": {
+ "format": "double",
+ "description": "Number of CPU cores needed.",
+ "type": "number"
+ }
+ },
+ "id": "Resources"
+ },
+ "Deployment": {
+ "type": "object",
+ "properties": {
+ "zip": {
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
+ },
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ },
+ "build": {
+ "$ref": "BuildInfo",
+ "description": "Google Cloud Container Builder build information."
+ },
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object"
+ }
+ },
+ "id": "Deployment",
+ "description": "Code and application artifacts used to deploy a version to App Engine."
+ },
+ "Volume": {
+ "id": "Volume",
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ },
+ "sizeGb": {
+ "format": "double",
+ "description": "Volume size in gigabytes.",
+ "type": "number"
+ },
+ "name": {
+ "description": "Unique name for the volume.",
+ "type": "string"
+ }
+ }
+ },
+ "BatchUpdateIngressRulesResponse": {
+ "type": "object",
+ "properties": {
+ "ingressRules": {
+ "description": "The full list of ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchUpdateIngressRulesResponse",
+ "description": "Response message for Firewall.UpdateAllIngressRules."
+ },
+ "ListInstancesResponse": {
+ "type": "object",
+ "properties": {
"instances": {
"description": "The instances belonging to the requested version.",
"items": {
"$ref": "Instance"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
}
},
"id": "ListInstancesResponse",
- "description": "Response message for Instances.ListInstances.",
- "type": "object"
+ "description": "Response message for Instances.ListInstances."
},
"ListDomainMappingsResponse": {
"description": "Response message for DomainMappings.ListDomainMappings.",
@@ -1606,21 +2537,21 @@
},
"type": "array"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
},
"method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly"
},
"endTime": {
"format": "google-datetime",
@@ -1635,16 +2566,16 @@
"type": "object",
"properties": {
"service": {
- "type": "string",
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default."
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
},
"domain": {
"description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
"type": "string"
},
"path": {
- "type": "string",
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters."
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
}
},
"id": "UrlDispatchRule"
@@ -1653,23 +2584,21 @@
"description": "Response message for Versions.ListVersions.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
"versions": {
"description": "The versions belonging to the requested service.",
"items": {
"$ref": "Version"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
"id": "ListVersionsResponse"
},
"ListAuthorizedDomainsResponse": {
- "id": "ListAuthorizedDomainsResponse",
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -1683,20 +2612,31 @@
},
"type": "array"
}
- }
+ },
+ "id": "ListAuthorizedDomainsResponse",
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains."
+ },
+ "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": {
+ "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 {}."
},
"DomainMapping": {
"description": "A domain serving an App Engine application.",
"type": "object",
"properties": {
- "sslSettings": {
- "$ref": "SslSettings",
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
- },
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- },
"resourceRecords": {
"description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
"items": {
@@ -1705,84 +2645,70 @@
"type": "array"
},
"id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
- "type": "string"
+ "type": "string",
+ "description": "Relative name of the domain serving the application. Example: example.com."
+ },
+ "sslSettings": {
+ "$ref": "SslSettings",
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
+ },
+ "name": {
+ "type": "string",
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly"
}
},
"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"
- },
"AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
"type": "object",
"properties": {
- "diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "DiskUtilization"
- },
"minPendingLatency": {
"format": "google-duration",
"description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
"type": "string"
},
"standardSchedulerSettings": {
- "$ref": "StandardSchedulerSettings",
- "description": "Scheduler settings for standard environment."
+ "description": "Scheduler settings for standard environment.",
+ "$ref": "StandardSchedulerSettings"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
},
"maxIdleInstances": {
"format": "int32",
"description": "Maximum number of idle instances that should be maintained for this version.",
"type": "integer"
},
- "requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
- },
"minIdleInstances": {
- "type": "integer",
"format": "int32",
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service."
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "type": "integer"
},
"maxTotalInstances": {
- "type": "integer",
"format": "int32",
- "description": "Maximum number of instances that should be started to handle requests."
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "type": "integer"
},
"minTotalInstances": {
- "type": "integer",
"format": "int32",
- "description": "Minimum number of instances that should be maintained for this version."
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "type": "integer"
},
"networkUtilization": {
"$ref": "NetworkUtilization",
"description": "Target scaling by network usage."
},
- "maxConcurrentRequests": {
- "format": "int32",
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "type": "integer"
- },
"coolDownPeriod": {
"format": "google-duration",
"description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
"type": "string"
},
+ "maxConcurrentRequests": {
+ "format": "int32",
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "type": "integer"
+ },
"maxPendingLatency": {
"format": "google-duration",
"description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
@@ -1791,57 +2717,37 @@
"cpuUtilization": {
"$ref": "CpuUtilization",
"description": "Target scaling by CPU usage."
+ },
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
}
},
- "id": "AutomaticScaling"
+ "id": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
},
"ZipInfo": {
+ "description": "The zip file information for a zip deployment.",
+ "type": "object",
"properties": {
"sourceUrl": {
"description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
"type": "string"
},
"filesCount": {
+ "type": "integer",
"format": "int32",
- "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
- "type": "integer"
+ "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."
}
},
- "id": "ZipInfo",
- "description": "The zip file information for a zip deployment.",
- "type": "object"
+ "id": "ZipInfo"
},
"AuthorizedCertificate": {
- "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
"type": "object",
"properties": {
- "id": {
- "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
- "type": "string"
- },
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
- "type": "string"
- },
- "certificateRawData": {
- "$ref": "CertificateRawData",
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
- },
- "visibleDomainMappings": {
- "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "expireTime": {
- "format": "google-datetime",
- "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
- "type": "string"
- },
"name": {
- "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly"
},
"domainMappingsCount": {
"format": "int32",
@@ -1854,64 +2760,89 @@
"type": "string"
},
"type": "array"
+ },
+ "id": {
+ "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "type": "string"
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate."
+ },
+ "certificateRawData": {
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
+ "$ref": "CertificateRawData"
+ },
+ "visibleDomainMappings": {
+ "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "expireTime": {
+ "format": "google-datetime",
+ "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
+ "type": "string"
}
},
- "id": "AuthorizedCertificate"
+ "id": "AuthorizedCertificate",
+ "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains."
},
"ResourceRecord": {
- "id": "ResourceRecord",
"description": "A DNS resource record.",
"type": "object",
"properties": {
- "rrdata": {
- "type": "string",
- "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)."
- },
"name": {
"description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
"type": "string"
},
"type": {
- "type": "string",
- "enumDescriptions": [
- "An A resource record. Data is an IPv4 address.",
- "An AAAA resource record. Data is an IPv6 address.",
- "A CNAME resource record. Data is a domain name to be aliased."
- ],
"enum": [
"A",
"AAAA",
"CNAME"
],
- "description": "Resource record type. Example: AAAA."
- }
- }
- },
- "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"
+ "description": "Resource record type. Example: AAAA.",
+ "type": "string",
+ "enumDescriptions": [
+ "An A resource record. Data is an IPv4 address.",
+ "An AAAA resource record. Data is an IPv6 address.",
+ "A CNAME resource record. Data is a domain name to be aliased."
+ ]
},
- "name": {
- "description": "Name of the library. Example: \"django\".",
+ "rrdata": {
+ "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
"type": "string"
}
},
- "id": "Library"
+ "id": "ResourceRecord"
+ },
+ "Library": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ }
+ },
+ "id": "Library",
+ "description": "Third-party Python runtime library that is required by the application."
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
"locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
- "type": "array",
- "description": "A list of locations that matches the specified filter in the request."
+ "type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -1921,7 +2852,6 @@
"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": {
@@ -1929,15 +2859,17 @@
"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."
},
"RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
"type": "object",
"properties": {
"targetRequestCountPerSecond": {
- "type": "integer",
"format": "int32",
- "description": "Target requests per second."
+ "description": "Target requests per second.",
+ "type": "integer"
},
"targetConcurrentRequests": {
"format": "int32",
@@ -1945,31 +2877,58 @@
"type": "integer"
}
},
- "id": "RequestUtilization",
- "description": "Target scaling by request utilization. Only applicable for VM runtimes."
- },
- "EndpointsApiService": {
- "type": "object",
- "properties": {
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "type": "string"
- },
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- }
- },
- "id": "EndpointsApiService",
- "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)."
+ "id": "RequestUtilization"
},
"UrlMap": {
+ "id": "UrlMap",
"description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
"type": "object",
"properties": {
+ "authFailAction": {
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect."
+ },
+ "script": {
+ "description": "Executes a script to handle the request that matches this URL pattern.",
+ "$ref": "ScriptHandler"
+ },
+ "urlRegex": {
+ "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
+ "login": {
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ]
+ },
+ "apiEndpoint": {
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
+ },
"staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
},
"redirectHttpResponseCode": {
"enumDescriptions": [
@@ -2006,7 +2965,63 @@
],
"description": "Security (HTTPS) enforcement for this URL.",
"type": "string"
+ }
+ }
+ },
+ "EndpointsApiService": {
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "type": "object",
+ "properties": {
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "type": "string"
},
+ "name": {
+ "type": "string",
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\""
+ }
+ },
+ "id": "EndpointsApiService"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of 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 contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Operation"
+ },
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object",
+ "properties": {
"authFailAction": {
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
@@ -2022,40 +3037,25 @@
"type": "string"
},
"script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches this URL pattern."
- },
- "urlRegex": {
- "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "description": "Path to the script from the application root directory.",
"type": "string"
},
"login": {
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
"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"
+ ],
+ "description": "Level of login required to access this resource. Defaults to optional."
},
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- }
- },
- "id": "UrlMap"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
"url": {
"description": "URL to serve the endpoint at.",
"type": "string"
@@ -2077,99 +3077,15 @@
"SECURE_OPTIONAL",
"SECURE_ALWAYS"
]
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string"
}
},
"id": "ApiConfigHandler"
},
- "Operation": {
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- }
- }
- },
"StaticFilesHandler": {
+ "id": "StaticFilesHandler",
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
"type": "object",
"properties": {
- "expiration": {
- "type": "string",
- "format": "google-duration",
- "description": "Time a static file served by this handler should be cached by web proxies and browsers."
- },
- "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"
@@ -2183,38 +3099,53 @@
"type": "string"
},
"requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean",
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist."
+ },
+ "expiration": {
+ "format": "google-duration",
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "type": "string"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
"type": "boolean"
}
- },
- "id": "StaticFilesHandler"
+ }
},
"DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "targetReadOpsPerSecond": {
- "format": "int32",
- "description": "Target ops read per seconds.",
- "type": "integer"
- },
- "targetReadBytesPerSecond": {
- "type": "integer",
- "format": "int32",
- "description": "Target bytes read per second."
- },
"targetWriteOpsPerSecond": {
"format": "int32",
"description": "Target ops written per second.",
"type": "integer"
},
"targetWriteBytesPerSecond": {
+ "type": "integer",
"format": "int32",
- "description": "Target bytes written per second.",
+ "description": "Target bytes written per second."
+ },
+ "targetReadOpsPerSecond": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Target ops read per seconds."
+ },
+ "targetReadBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes read per second.",
"type": "integer"
}
},
- "id": "DiskUtilization",
- "description": "Target scaling by disk usage. Only applicable for VM runtimes."
+ "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.",
@@ -2243,46 +3174,44 @@
"type": "string"
},
"targetUtilization": {
- "type": "number",
"format": "double",
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1."
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "type": "number"
}
},
"id": "CpuUtilization"
},
"IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
"type": "object",
"properties": {
- "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"
+ "type": "string",
+ "description": "OAuth2 client ID to use for the authentication flow."
},
"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"
+ "id": "IdentityAwareProxy",
+ "description": "Identity-Aware Proxy"
},
"Status": {
+ "id": "Status",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
"message": {
- "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."
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
@@ -2294,14 +3223,15 @@
"type": "object"
},
"type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
}
- },
- "id": "Status",
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
+ }
},
"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": {
@@ -2310,9 +3240,11 @@
"type": "integer"
}
},
- "id": "ManualScaling"
+ "id": "ManualScaling",
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
},
"LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
"type": "object",
"properties": {
"flexibleEnvironmentAvailable": {
@@ -2324,17 +3256,11 @@
"type": "boolean"
}
},
- "id": "LocationMetadata",
- "description": "Metadata for the given google.cloud.location.Location."
+ "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"
@@ -2342,12 +3268,16 @@
"name": {
"description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
+ },
+ "split": {
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
+ "$ref": "TrafficSplit"
}
},
- "id": "Service"
+ "id": "Service",
+ "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service."
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -2355,28 +3285,18 @@
"type": "string"
},
"operations": {
- "description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
- "type": "array"
+ "type": "array",
+ "description": "A list of operations that matches the specified filter in the request."
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations."
},
"OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
"properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation completed.@OutputOnly",
- "type": "string"
- },
"operationType": {
"description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
"type": "string"
@@ -2386,21 +3306,40 @@
"description": "Timestamp that this operation was created.@OutputOnly",
"type": "string"
},
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation completed.@OutputOnly",
"type": "string"
}
},
- "id": "OperationMetadata"
+ "id": "OperationMetadata",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
},
"FirewallRule": {
- "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
"type": "object",
"properties": {
+ "sourceRange": {
+ "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.\u003cp\u003eTruncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.",
+ "type": "string"
+ },
+ "priority": {
+ "format": "int32",
+ "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.",
+ "type": "integer"
+ },
"action": {
"enum": [
"UNSPECIFIED_ACTION",
@@ -2416,27 +3355,20 @@
]
},
"description": {
- "type": "string",
- "description": "An optional string description of this rule. This field has a maximum length of 100 characters."
- },
- "sourceRange": {
- "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.\u003cp\u003eTruncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.",
+ "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
"type": "string"
- },
- "priority": {
- "format": "int32",
- "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.",
- "type": "integer"
}
},
- "id": "FirewallRule"
+ "id": "FirewallRule",
+ "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests."
},
"ListAuthorizedCertificatesResponse": {
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
"type": "object",
"properties": {
"nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "type": "string",
+ "description": "Continuation token for fetching the next page of results."
},
"certificates": {
"description": "The SSL certificates the user is authorized to administer.",
@@ -2446,39 +3378,27 @@
"type": "array"
}
},
- "id": "ListAuthorizedCertificatesResponse",
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates."
+ "id": "ListAuthorizedCertificatesResponse"
},
"FeatureSettings": {
- "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
- "type": "object",
"properties": {
"splitHealthChecks": {
"description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.",
"type": "boolean"
}
},
- "id": "FeatureSettings"
+ "id": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
+ "type": "object"
},
"OperationMetadataV1": {
+ "id": "OperationMetadataV1",
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "type": "string",
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly"
- },
"method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly"
},
"endTime": {
"format": "google-datetime",
@@ -2496,11 +3416,23 @@
"format": "google-datetime",
"description": "Time that this operation was created.@OutputOnly",
"type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "type": "string",
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly"
}
- },
- "id": "OperationMetadataV1"
+ }
},
"SslSettings": {
+ "id": "SslSettings",
"description": "SSL configuration for a DomainMapping resource.",
"type": "object",
"properties": {
@@ -2508,16 +3440,15 @@
"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": {
"mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
+ "type": "string",
+ "description": "MIME type of file. Defaults to text/html."
},
"errorCode": {
"enumDescriptions": [
@@ -2543,946 +3474,11 @@
}
},
"id": "ErrorHandler"
- },
- "Application": {
- "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": {
- "type": "string",
- "enumDescriptions": [
- "Serving status is unspecified.",
- "Application is serving.",
- "Application has been disabled by the user.",
- "Application has been disabled by the system."
- ],
- "enum": [
- "UNSPECIFIED",
- "SERVING",
- "USER_DISABLED",
- "SYSTEM_DISABLED"
- ],
- "description": "Serving status of this application."
- },
- "defaultHostname": {
- "type": "string",
- "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly"
- },
- "featureSettings": {
- "$ref": "FeatureSettings",
- "description": "The feature specific settings to be used in the application."
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "codeBucket": {
- "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
- "items": {
- "$ref": "UrlDispatchRule"
- },
- "type": "array"
- },
- "gcrDomain": {
- "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "format": "google-duration",
- "description": "Cookie expiration policy for this application.",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- }
- },
- "id": "Application",
- "description": "An Application resource contains the top-level configuration of an App Engine application. Next tag: 20",
- "type": "object"
- },
- "Network": {
- "description": "Extra network settings. Only applicable for App Engine flexible environment versions",
- "type": "object",
- "properties": {
- "subnetworkName": {
- "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.",
- "type": "string"
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation. Only applicable for for App Engine flexible environment versions.",
- "type": "string"
- },
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable for App Engine flexible environment versions.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
- "Instance": {
- "properties": {
- "qps": {
- "format": "float",
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "type": "number"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "averageLatency": {
- "format": "int32",
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "type": "integer"
- },
- "id": {
- "type": "string",
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly"
- },
- "vmIp": {
- "type": "string",
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly"
- },
- "memoryUsage": {
- "format": "int64",
- "description": "Total memory in use (bytes).@OutputOnly",
- "type": "string"
- },
- "vmStatus": {
- "type": "string",
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly"
- },
- "errors": {
- "format": "int32",
- "description": "Number of errors since this instance was started.@OutputOnly",
- "type": "integer"
- },
- "availability": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Time that this instance was started.@OutputOnly",
- "type": "string"
- },
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "requests": {
- "type": "integer",
- "format": "int32",
- "description": "Number of requests since this instance was started.@OutputOnly"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Instance",
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object"
- },
- "LivenessCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object",
- "properties": {
- "successThreshold": {
- "format": "uint32",
- "description": "Number of consecutive successful checks required before considering the VM healthy.",
- "type": "integer"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- },
- "failureThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "type": "integer"
- },
- "timeout": {
- "format": "google-duration",
- "description": "Time before the check is considered failed.",
- "type": "string"
- },
- "initialDelay": {
- "format": "google-duration",
- "description": "The initial delay before starting to execute the checks.",
- "type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- }
- },
- "id": "LivenessCheck"
- },
- "BatchUpdateIngressRulesRequest": {
- "id": "BatchUpdateIngressRulesRequest",
- "description": "Request message for Firewall.BatchUpdateIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "A list of FirewallRules to replace the existing set.",
- "items": {
- "$ref": "FirewallRule"
- },
- "type": "array"
- }
- }
- },
- "Location": {
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- }
- },
- "NetworkUtilization": {
- "id": "NetworkUtilization",
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetSentBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes sent per second.",
- "type": "integer"
- },
- "targetReceivedBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes received per second.",
- "type": "integer"
- },
- "targetSentPacketsPerSecond": {
- "format": "int32",
- "description": "Target packets sent per second.",
- "type": "integer"
- },
- "targetReceivedPacketsPerSecond": {
- "format": "int32",
- "description": "Target packets received per second.",
- "type": "integer"
- }
- }
- },
- "HealthCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object",
- "properties": {
- "timeout": {
- "format": "google-duration",
- "description": "Time before the health check is considered failed.",
- "type": "string"
- },
- "unhealthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "healthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "type": "integer"
- },
- "restartThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "type": "integer"
- },
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- }
- },
- "id": "HealthCheck"
- },
- "ReadinessCheck": {
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "type": "object",
- "properties": {
- "failureThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed checks required before removing traffic.",
- "type": "integer"
- },
- "timeout": {
- "format": "google-duration",
- "description": "Time before the check is considered failed.",
- "type": "string"
- },
- "appStartTimeout": {
- "format": "google-duration",
- "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
- "type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- },
- "successThreshold": {
- "type": "integer",
- "format": "uint32",
- "description": "Number of consecutive successful checks required before receiving traffic."
- },
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- }
- },
- "id": "ReadinessCheck"
- },
- "StandardSchedulerSettings": {
- "description": "Scheduler settings for standard environment.",
- "type": "object",
- "properties": {
- "targetThroughputUtilization": {
- "format": "double",
- "description": "Target throughput utilization ratio to maintain when scaling",
- "type": "number"
- },
- "maxInstances": {
- "format": "int32",
- "description": "Maximum number of instances for an app version. Set to a non-positive value (0 by convention) to disable max_instances configuration.",
- "type": "integer"
- },
- "minInstances": {
- "format": "int32",
- "description": "Minimum number of instances for an app version. Set to a non-positive value (0 by convention) to disable min_instances configuration.",
- "type": "integer"
- },
- "targetCpuUtilization": {
- "format": "double",
- "description": "Target CPU utilization ratio to maintain when scaling.",
- "type": "number"
- }
- },
- "id": "StandardSchedulerSettings"
- },
- "DebugInstanceRequest": {
- "description": "Request message for Instances.DebugInstance.",
- "type": "object",
- "properties": {
- "sshKey": {
- "type": "string",
- "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)."
- }
- },
- "id": "DebugInstanceRequest"
- },
- "OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation completed.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta5"
- },
- "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",
- "properties": {
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
- "type": "string"
- },
- "envVariables": {
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "livenessCheck": {
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
- "$ref": "LivenessCheck"
- },
- "network": {
- "$ref": "Network",
- "description": "Extra network settings. Only applicable for App Engine flexible environment versions."
- },
- "betaSettings": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata settings that are supplied to this version to enable beta runtime features."
- },
- "env": {
- "description": "App Engine execution environment for this version.Defaults to standard.",
- "type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "UrlMap"
- },
- "type": "array"
- },
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "diskUsageBytes": {
- "format": "int64",
- "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
- "type": "string"
- },
- "healthCheck": {
- "$ref": "HealthCheck",
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "readinessCheck": {
- "$ref": "ReadinessCheck",
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set."
- },
- "manualScaling": {
- "$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": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
- },
- "endpointsApiService": {
- "$ref": "EndpointsApiService",
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
- },
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
- "type": "string"
- },
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "instanceClass": {
- "type": "string",
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling."
- },
- "servingStatus": {
- "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ],
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ]
- },
- "runtimeApiVersion": {
- "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
- "type": "string"
- },
- "deployment": {
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
- "$ref": "Deployment"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Time that this version was created.@OutputOnly",
- "type": "string"
- },
- "inboundServices": {
- "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
- "items": {
- "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"
- },
- "type": "array",
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ]
- },
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "ErrorHandler"
- },
- "type": "array"
- },
- "defaultExpiration": {
- "format": "google-duration",
- "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "libraries": {
- "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "Library"
- },
- "type": "array"
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "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"
- }
- }
- },
- "RepairApplicationRequest": {
- "description": "Request message for 'Applications.RepairApplication'.",
- "type": "object",
- "properties": {},
- "id": "RepairApplicationRequest"
- },
- "BuildInfo": {
- "properties": {
- "cloudBuildId": {
- "description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"",
- "type": "string"
- }
- },
- "id": "BuildInfo",
- "description": "Google Cloud Container Builder build information.",
- "type": "object"
- },
- "CertificateRawData": {
- "id": "CertificateRawData",
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
- "properties": {
- "privateKey": {
- "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
- "type": "string"
- },
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
- "type": "string"
- }
- }
- },
- "FileInfo": {
- "id": "FileInfo",
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "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"
- }
- }
- },
- "ScriptHandler": {
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ScriptHandler",
- "description": "Executes a script to handle the request that matches the URL pattern."
- },
- "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": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataExperimental"
- },
- "AuthorizedDomain": {
- "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com."
- },
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- }
- },
- "id": "AuthorizedDomain"
- },
- "TrafficSplit": {
- "type": "object",
- "properties": {
- "allocations": {
- "additionalProperties": {
- "type": "number",
- "format": "double"
- },
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object"
- },
- "shardBy": {
- "type": "string",
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
- "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
- ],
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP",
- "RANDOM"
- ],
- "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."
- }
- },
- "id": "TrafficSplit",
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions."
- },
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "OperationMetadataV1Beta"
- },
- "ListIngressRulesResponse": {
- "description": "Response message for Firewall.ListIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "The ingress FirewallRules for this application.",
- "items": {
- "$ref": "FirewallRule"
- },
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Continuation token for fetching the next page of results."
- }
- },
- "id": "ListIngressRulesResponse"
- },
- "ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "services": {
- "description": "The services belonging to the requested application.",
- "items": {
- "$ref": "Service"
- },
- "type": "array"
- }
- },
- "id": "ListServicesResponse"
- },
- "Deployment": {
- "type": "object",
- "properties": {
- "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": {
- "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"
- }
- },
- "zip": {
- "description": "The zip file for this deployment, if this is a zip deployment.",
- "$ref": "ZipInfo"
- }
- },
- "id": "Deployment",
- "description": "Code and application artifacts used to deploy a version to App Engine."
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "volumes": {
- "items": {
- "$ref": "Volume"
- },
- "type": "array",
- "description": "User specified volumes."
- },
- "diskGb": {
- "format": "double",
- "description": "Disk size (GB) needed.",
- "type": "number"
- },
- "memoryGb": {
- "format": "double",
- "description": "Memory (GB) needed.",
- "type": "number"
- },
- "cpu": {
- "type": "number",
- "format": "double",
- "description": "Number of CPU cores needed."
- }
- },
- "id": "Resources"
- },
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
- },
- "sizeGb": {
- "type": "number",
- "format": "double",
- "description": "Volume size in gigabytes."
- },
- "name": {
- "description": "Unique name for the volume.",
- "type": "string"
- }
- },
- "id": "Volume"
- },
- "BatchUpdateIngressRulesResponse": {
- "description": "Response message for Firewall.UpdateAllIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "The full list of ingress FirewallRules for this application.",
- "items": {
- "$ref": "FirewallRule"
- },
- "type": "array"
- }
- },
- "id": "BatchUpdateIngressRulesResponse"
}
},
"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": "v1beta",
@@ -3502,7 +3498,11 @@
}
}
},
- "servicePath": "",
+ "kind": "discovery#restDescription",
"description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "kind": "discovery#restDescription"
+ "servicePath": "",
+ "rootUrl": "https://appengine.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "appengine"
}
diff --git a/appengine/v1beta/appengine-gen.go b/appengine/v1beta/appengine-gen.go
index 8f839c5..1fc8c0c 100644
--- a/appengine/v1beta/appengine-gen.go
+++ b/appengine/v1beta/appengine-gen.go
@@ -8741,6 +8741,27 @@
// ta/apps.services.versions#Version.FIELDS.automatic_scaling): For
// Version resources that use automatic scaling and run in the App
// Engine standard environment.
+// automatic_scaling.min_total_instances
+// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1be
+// ta/apps.services.versions#Version.FIELDS.automatic_scaling): For
+// Version resources that use automatic scaling and run in the App
+// Engine Flexible environment.
+// automatic_scaling.max_total_instances
+// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1be
+// ta/apps.services.versions#Version.FIELDS.automatic_scaling): For
+// Version resources that use automatic scaling and run in the App
+// Engine Flexible environment.
+// automatic_scaling.cool_down_period_sec
+// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1be
+// ta/apps.services.versions#Version.FIELDS.automatic_scaling): For
+// Version resources that use automatic scaling and run in the App
+// Engine Flexible
+// environment.
+// automatic_scaling.cpu_utilization.target_utilization
+// (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1be
+// ta/apps.services.versions#Version.FIELDS.automatic_scaling): For
+// Version resources that use automatic scaling and run in the App
+// Engine Flexible environment.
func (r *AppsServicesVersionsService) Patch(appsId string, servicesId string, versionsId string, version *Version) *AppsServicesVersionsPatchCall {
c := &AppsServicesVersionsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -8845,7 +8866,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
// "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
// "httpMethod": "PATCH",
// "id": "appengine.apps.services.versions.patch",
diff --git a/appengine/v1beta4/appengine-api.json b/appengine/v1beta4/appengine-api.json
index b3fd571..7ef1bb3 100644
--- a/appengine/v1beta4/appengine-api.json
+++ b/appengine/v1beta4/appengine-api.json
@@ -1,17 +1,33 @@
{
- "basePath": "",
- "ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
+ "revision": "20170823",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"id": "appengine:v1beta4",
- "revision": "20170811",
"title": "Google App Engine Admin API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"apps": {
"methods": {
+ "create": {
+ "path": "v1beta4/apps",
+ "id": "appengine.apps.create",
+ "request": {
+ "$ref": "Application"
+ },
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta4/apps"
+ },
"patch": {
"response": {
"$ref": "Operation"
@@ -25,16 +41,16 @@
],
"parameters": {
"mask": {
+ "location": "query",
"format": "google-fieldmask",
"description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"flatPath": "v1beta4/apps/{appsId}",
@@ -46,267 +62,84 @@
"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)"
},
"get": {
- "response": {
- "$ref": "Application"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
- "parameters": {
- "ensureResourcesExist": {
- "location": "query",
- "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
- "type": "boolean"
- },
- "appsId": {
- "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1beta4/apps/{appsId}",
- "description": "Gets information about an application."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta4/apps",
- "path": "v1beta4/apps",
- "id": "appengine.apps.create",
- "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/)."
+ "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.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}",
+ "path": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "description": "Gets information about an application."
}
},
"resources": {
- "operations": {
- "methods": {
- "get": {
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "path": "v1beta4/apps/{appsId}/operations",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
- }
- }
- },
- "locations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "type": "string",
- "required": true
- },
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "path": "v1beta4/apps/{appsId}/locations/{locationsId}",
- "description": "Get information about a location."
- },
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "path": "v1beta4/apps/{appsId}/locations",
- "description": "Lists information about the supported locations for this service."
- }
- }
- },
"modules": {
"methods": {
"delete": {
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.delete",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
"description": "Deletes the specified module and all enclosed versions.",
- "response": {
- "$ref": "Operation"
- },
"parameterOrder": [
"appsId",
"modulesId"
],
+ "response": {
+ "$ref": "Operation"
+ },
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
}
- }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.delete",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}"
},
"patch": {
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.patch",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "description": "Updates the configuration of the specified module.",
- "request": {
- "$ref": "Module"
- },
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"modulesId"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default."
},
"migrateTraffic": {
"location": "query",
@@ -328,10 +161,16 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.patch",
+ "description": "Updates the configuration of the specified module.",
+ "request": {
+ "$ref": "Module"
+ }
},
"list": {
- "description": "Lists all the modules in the application.",
"response": {
"$ref": "ListModulesResponse"
},
@@ -340,22 +179,22 @@
],
"httpMethod": "GET",
"parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
"pageToken": {
"location": "query",
"description": "Continuation token for fetching the next page of results.",
"type": "string"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -365,9 +204,29 @@
],
"flatPath": "v1beta4/apps/{appsId}/modules",
"id": "appengine.apps.modules.list",
- "path": "v1beta4/apps/{appsId}/modules"
+ "path": "v1beta4/apps/{appsId}/modules",
+ "description": "Lists all the modules in the application."
},
"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": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default."
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
"id": "appengine.apps.modules.get",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}",
@@ -379,36 +238,17 @@
"appsId",
"modulesId"
],
- "httpMethod": "GET",
- "parameters": {
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ "httpMethod": "GET"
}
},
"resources": {
"versions": {
"methods": {
"patch": {
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
"request": {
"$ref": "Version"
},
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
"httpMethod": "PATCH",
"parameterOrder": [
"appsId",
@@ -418,15 +258,18 @@
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default/versions/1.",
+ "type": "string",
+ "required": true
+ },
"mask": {
+ "location": "query",
"format": "google-fieldmask",
"description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"versionsId": {
"location": "path",
@@ -435,25 +278,21 @@
"required": true
},
"modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true
- },
- "appsId": {
+ "required": true,
"location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default/versions/1.",
- "type": "string",
- "required": true
+ "description": "Part of `name`. See documentation of `appsId`."
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
"id": "appengine.apps.modules.versions.patch"
},
"list": {
"description": "Lists the versions of a module.",
- "httpMethod": "GET",
"response": {
"$ref": "ListVersionsResponse"
},
@@ -461,12 +300,28 @@
"appsId",
"modulesId"
],
+ "httpMethod": "GET",
"parameters": {
- "pageToken": {
+ "view": {
"location": "query",
- "description": "Continuation token for fetching the next page of results.",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List response.",
"type": "string"
},
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
"type": "string",
@@ -478,21 +333,6 @@
"description": "Maximum results to return per page.",
"type": "integer",
"location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
}
},
"scopes": [
@@ -501,10 +341,14 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "id": "appengine.apps.modules.versions.list"
+ "id": "appengine.apps.modules.versions.list",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions"
},
"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"
},
@@ -514,27 +358,32 @@
"versionsId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1."
},
"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"
},
"versionsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"modulesId": {
"location": "path",
@@ -542,18 +391,13 @@
"type": "string",
"required": true
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
+ }
},
"create": {
+ "description": "Deploys code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ },
"response": {
"$ref": "Operation"
},
@@ -563,17 +407,17 @@
],
"httpMethod": "POST",
"parameters": {
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
"appsId": {
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
@@ -581,29 +425,27 @@
],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
"id": "appengine.apps.modules.versions.create",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "description": "Deploys code and resource files to a new version.",
- "request": {
- "$ref": "Version"
- }
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions"
},
"delete": {
- "description": "Deletes an existing version.",
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"modulesId",
"versionsId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"versionsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"modulesId": {
"location": "path",
@@ -612,169 +454,21 @@
"required": true
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "id": "appengine.apps.modules.versions.delete",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.delete"
+ "description": "Deletes an existing version."
}
},
"resources": {
"instances": {
"methods": {
- "list": {
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.modules.versions.instances.list",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "get": {
- "description": "Gets instance information.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.get"
- },
- "debug": {
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.modules.versions.instances.debug",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug"
- },
"delete": {
"description": "Stops a running instance.",
"response": {
@@ -787,22 +481,119 @@
"instancesId"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "modulesId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ },
+ "instancesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true,
"location": "path"
},
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
"modulesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true
},
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
+ "id": "appengine.apps.modules.versions.instances.list",
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
+ },
+ "get": {
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "modulesId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ },
"instancesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
@@ -817,83 +608,246 @@
}
},
"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}"
+ "id": "appengine.apps.modules.versions.instances.get",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Gets instance information."
+ },
+ "debug": {
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.modules.versions.instances.debug",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ }
}
}
}
}
}
}
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation resource.",
+ "type": "string",
+ "required": true
+ },
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "path": "v1beta4/apps/{appsId}/operations",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "get": {
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Resource name for the location.",
+ "type": "string",
+ "required": true
+ },
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "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"
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size."
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "path": "v1beta4/apps/{appsId}/locations"
+ }
+ }
}
}
}
},
"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": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"pp": {
- "location": "query",
- "description": "Pretty-print response.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query",
+ "description": "Pretty-print response."
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "oauth_token": {
+ "bearer_token": {
+ "type": "string",
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "description": "OAuth bearer token."
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -901,77 +855,633 @@
"location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "boolean",
+ "location": "query"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
}
},
"schemas": {
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object",
+ "properties": {
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "errorCode": {
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "description": "Error condition this handler applies to.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly"
+ },
+ "user": {
+ "type": "string",
+ "description": "User who requested this operation.@OutputOnly"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Alpha"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "Cookie expiration policy for this application."
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "codeBucket": {
+ "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
+ "type": "string"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent.@OutputOnly",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Application"
+ },
+ "Network": {
+ "properties": {
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ }
+ },
+ "id": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "type": "object"
+ },
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object",
+ "properties": {
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "format": "float",
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "type": "number"
+ },
+ "vmUnlocked": {
+ "type": "boolean",
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "format": "int32",
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "type": "integer"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "type": "string",
+ "format": "int64",
+ "description": "Total memory in use (bytes).@OutputOnly"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "availability": {
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ },
+ "errors": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "Number of errors since this instance was started.@OutputOnly"
+ },
+ "requests": {
+ "format": "int32",
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "startTimestamp": {
+ "format": "google-datetime",
+ "description": "Time that this instance was started.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Instance"
+ },
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a module.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule"
+ },
+ "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": {
+ "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": {
+ "description": "Relative name of the module within the application. Example: default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Module"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
+ "properties": {
+ "versions": {
+ "description": "The versions belonging to the requested module.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListVersionsResponse"
+ },
+ "ApiEndpointHandler": {
+ "id": "ApiEndpointHandler",
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs."
+ },
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "format": "google-duration",
+ "description": "Time a static file served by this handler should be cached.",
+ "type": "string"
+ }
+ },
+ "id": "StaticDirectoryHandler"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object",
+ "properties": {
+ "diskUtilization": {
+ "description": "Target scaling by disk usage.",
+ "$ref": "DiskUtilization"
+ },
+ "minPendingLatency": {
+ "format": "google-duration",
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "type": "string"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "maxIdleInstances": {
+ "format": "int32",
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "type": "integer"
+ },
+ "minIdleInstances": {
+ "format": "int32",
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "format": "int32",
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "coolDownPeriod": {
+ "format": "google-duration",
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "type": "string"
+ },
+ "maxConcurrentRequests": {
+ "format": "int32",
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "type": "integer"
+ },
+ "maxPendingLatency": {
+ "format": "google-duration",
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "$ref": "CpuUtilization"
+ }
+ },
+ "id": "AutomaticScaling"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReceivedBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes received per second.",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSec": {
+ "format": "int32",
+ "description": "Target packets sent per second.",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSec": {
+ "format": "int32",
+ "description": "Target packets received per second.",
+ "type": "integer"
+ },
+ "targetSentBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes sent per second.",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization"
+ },
+ "Location": {
+ "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",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
+ },
"HealthCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"type": "object",
"properties": {
- "timeout": {
- "format": "google-duration",
- "description": "Time before the health check is considered failed.",
- "type": "string"
- },
- "unhealthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
"host": {
"description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
"type": "string"
},
- "healthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "type": "integer"
- },
"restartThreshold": {
"format": "uint32",
"description": "Number of consecutive failed health checks required before an instance is restarted.",
"type": "integer"
},
+ "healthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "type": "integer"
+ },
"checkInterval": {
"format": "google-duration",
"description": "Interval between health checks.",
"type": "string"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the health check is considered failed.",
+ "type": "string"
+ },
+ "unhealthyThreshold": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before removing traffic."
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
}
},
"id": "HealthCheck"
},
"SourceReference": {
+ "id": "SourceReference",
"description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
"type": "object",
"properties": {
"repository": {
- "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
- "type": "string"
+ "type": "string",
+ "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\""
},
"revisionId": {
"description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
"type": "string"
}
- },
- "id": "SourceReference"
+ }
},
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
@@ -988,13 +1498,13 @@
"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"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the library. Example: \"django\"."
}
},
"id": "Library"
@@ -1003,32 +1513,33 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
- },
"endTime": {
"format": "google-datetime",
"description": "Timestamp that this operation completed.@OutputOnly",
"type": "string"
},
"target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly"
},
"user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "User who requested this operation.@OutputOnly"
},
"method": {
"description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "type": "string"
}
},
"id": "OperationMetadataV1Beta5"
},
"ListLocationsResponse": {
+ "id": "ListLocationsResponse",
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
@@ -1043,31 +1554,11 @@
},
"type": "array"
}
- },
- "id": "ListLocationsResponse"
- },
- "ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "image": {
- "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo"
+ }
},
"Version": {
- "description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.",
"type": "object",
"properties": {
- "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."
@@ -1080,8 +1571,8 @@
"type": "object"
},
"env": {
- "description": "App Engine execution environment to use for this version.Defaults to 1.",
- "type": "string"
+ "type": "string",
+ "description": "App Engine execution environment to use for this version.Defaults to 1."
},
"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.",
@@ -1091,8 +1582,8 @@
"type": "array"
},
"deployer": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "Email address of the user who created this version.@OutputOnly"
},
"automaticScaling": {
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
@@ -1103,8 +1594,8 @@
"description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
},
"threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether multiple requests can be dispatched to this version at once."
},
"manualScaling": {
"$ref": "ManualScaling",
@@ -1115,8 +1606,8 @@
"type": "string"
},
"apiConfig": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
},
"vm": {
"description": "Whether to deploy this version in a container on a virtual machine.",
@@ -1140,14 +1631,14 @@
"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"
},
+ "deployment": {
+ "$ref": "Deployment",
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
+ },
"inboundServices": {
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"items": {
@@ -1178,8 +1669,8 @@
]
},
"resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
},
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
@@ -1200,15 +1691,15 @@
},
"type": "array"
},
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
"creationTime": {
"format": "google-datetime",
"description": "Time that this version was created.@OutputOnly",
"type": "string"
},
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
"basicScaling": {
"$ref": "BasicScaling",
"description": "A 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."
@@ -1220,11 +1711,31 @@
"id": {
"description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
"type": "string"
+ },
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
}
},
- "id": "Version"
+ "id": "Version",
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a module."
+ },
+ "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": {
+ "id": "RequestUtilization",
"description": "Target scaling by request utilization. Only applicable for VM runtimes.",
"type": "object",
"properties": {
@@ -1238,16 +1749,21 @@
"description": "Target requests per second.",
"type": "integer"
}
- },
- "id": "RequestUtilization"
+ }
},
"UrlMap": {
"description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
"type": "object",
"properties": {
+ "script": {
+ "description": "Executes a script to handle the request that matches this URL pattern.",
+ "$ref": "ScriptHandler"
+ },
+ "urlRegex": {
+ "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
"login": {
- "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.",
@@ -1259,19 +1775,21 @@
"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": {
- "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"
+ "$ref": "StaticDirectoryHandler",
+ "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files."
},
"staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
},
"redirectHttpResponseCode": {
"description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
@@ -1292,6 +1810,7 @@
]
},
"securityLevel": {
+ "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.",
@@ -1306,11 +1825,9 @@
"SECURE_OPTIONAL",
"SECURE_ALWAYS"
],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
+ "description": "Security (HTTPS) enforcement for this URL."
},
"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.",
@@ -1321,25 +1838,90 @@
"AUTH_FAIL_ACTION_UNSPECIFIED",
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
- },
- "script": {
- "description": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
- },
- "urlRegex": {
- "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect."
}
},
"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": {
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
+ "response": {
+ "type": "object",
+ "additionalProperties": {
+ "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."
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "Operation"
+ },
+ "ApiConfigHandler": {
+ "properties": {
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ]
+ },
+ "authFailAction": {
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect."
+ },
+ "script": {
+ "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.",
@@ -1352,90 +1934,22 @@
"LOGIN_OPTIONAL",
"LOGIN_ADMIN",
"LOGIN_REQUIRED"
- ]
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- },
- "securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
+ "description": "Level of login required to access this resource. Defaults to optional."
}
},
- "id": "ApiConfigHandler"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "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": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- }
- },
- "id": "Operation"
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object"
},
"FileInfo": {
"description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
"type": "object",
"properties": {
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ },
"sha1Sum": {
"description": "The SHA1 hash of the file, in hex.",
"type": "string"
@@ -1443,15 +1957,12 @@
"mimeType": {
"description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
"type": "string"
- },
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
}
},
"id": "FileInfo"
},
"StaticFilesHandler": {
+ "id": "StaticFilesHandler",
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
"type": "object",
"properties": {
@@ -1487,20 +1998,46 @@
"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"
+ "type": "string",
+ "description": "Path to the script from the application root directory."
}
},
"id": "ScriptHandler"
},
+ "DiskUtilization": {
+ "id": "DiskUtilization",
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReadOpsPerSec": {
+ "format": "int32",
+ "description": "Target ops read per second.",
+ "type": "integer"
+ },
+ "targetReadBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes read per second.",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSec": {
+ "format": "int32",
+ "description": "Target ops written per second.",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes written per second.",
+ "type": "integer"
+ }
+ }
+ },
"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",
@@ -1518,37 +2055,18 @@
},
"id": "BasicScaling"
},
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetWriteBytesPerSec": {
- "format": "int32",
- "description": "Target bytes written per second.",
- "type": "integer"
- },
- "targetReadOpsPerSec": {
- "format": "int32",
- "description": "Target ops read per second.",
- "type": "integer"
- },
- "targetReadBytesPerSec": {
- "format": "int32",
- "description": "Target bytes read per second.",
- "type": "integer"
- },
- "targetWriteOpsPerSec": {
- "format": "int32",
- "description": "Target ops written per second.",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
"OperationMetadataExperimental": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
"type": "string"
@@ -1562,20 +2080,11 @@
"format": "google-datetime",
"description": "Time that this operation completed.@OutputOnly",
"type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
}
},
"id": "OperationMetadataExperimental"
},
"CpuUtilization": {
- "description": "Target scaling by CPU usage.",
"type": "object",
"properties": {
"aggregationWindowLength": {
@@ -1589,14 +2098,18 @@
"type": "number"
}
},
- "id": "CpuUtilization"
+ "id": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"type": "object",
"additionalProperties": {
@@ -1604,24 +2117,24 @@
"type": "any"
}
},
- "type": "array"
+ "type": "array",
+ "description": "A list of messages that carry the error details. There is a common 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 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.",
+ "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"
@@ -1633,15 +2146,13 @@
"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"
+ "id": "IdentityAwareProxy",
+ "description": "Identity-Aware Proxy"
},
"ManualScaling": {
+ "id": "ManualScaling",
"description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
"type": "object",
"properties": {
@@ -1650,20 +2161,17 @@
"description": "Number of instances to assign to the module at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
"type": "integer"
}
- },
- "id": "ManualScaling"
+ }
},
"TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions.",
- "type": "object",
"properties": {
"allocations": {
+ "description": "Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
- },
- "description": "Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object"
+ }
},
"shardBy": {
"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.",
@@ -1680,19 +2188,21 @@
]
}
},
- "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"
},
"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"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
"id": "LocationMetadata"
@@ -1701,6 +2211,26 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly"
+ },
+ "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"
@@ -1713,31 +2243,12 @@
"format": "google-datetime",
"description": "Time that this operation completed.@OutputOnly",
"type": "string"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "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": "OperationMetadataV1Beta"
},
"ListModulesResponse": {
+ "id": "ListModulesResponse",
"description": "Response message for Modules.ListModules.",
"type": "object",
"properties": {
@@ -1746,14 +2257,38 @@
"type": "string"
},
"modules": {
- "description": "The modules belonging to the requested application.",
"items": {
"$ref": "Module"
},
+ "type": "array",
+ "description": "The modules belonging to the requested application."
+ }
+ }
+ },
+ "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"
+ },
+ "sourceReferences": {
+ "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
+ "items": {
+ "$ref": "SourceReference"
+ },
"type": "array"
+ },
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
}
},
- "id": "ListModulesResponse"
+ "id": "Deployment"
},
"Resources": {
"description": "Machine resources for a version.",
@@ -1784,34 +2319,7 @@
},
"id": "Resources"
},
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
- "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"
- }
- },
- "sourceReferences": {
- "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
- "items": {
- "$ref": "SourceReference"
- },
- "type": "array"
- },
- "container": {
- "$ref": "ContainerInfo",
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
- }
- },
- "id": "Deployment"
- },
"Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
"properties": {
"sizeGb": {
"format": "double",
@@ -1827,7 +2335,9 @@
"type": "string"
}
},
- "id": "Volume"
+ "id": "Volume",
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -1856,14 +2366,14 @@
"description": "Timestamp that this operation was created.@OutputOnly",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
+ "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"
@@ -1879,518 +2389,6 @@
}
},
"id": "OperationMetadata"
- },
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
- "properties": {
- "instances": {
- "description": "The instances belonging to the requested version.",
- "items": {
- "$ref": "Instance"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListInstancesResponse"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "errorCode": {
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ],
- "description": "Error condition this handler applies to.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
- },
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Alpha"
- },
- "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",
- "items": {
- "$ref": "UrlDispatchRule"
- },
- "type": "array"
- },
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "format": "google-duration",
- "description": "Cookie expiration policy for this application.",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "codeBucket": {
- "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Application"
- },
- "Network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
- "properties": {
- "averageLatency": {
- "format": "int32",
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "type": "integer"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "format": "int64",
- "description": "Total memory in use (bytes).@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "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": {
- "format": "uint32",
- "description": "Number of errors since this instance was started.@OutputOnly",
- "type": "integer"
- },
- "requests": {
- "format": "int32",
- "description": "Number of requests since this instance was started.@OutputOnly",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "startTimestamp": {
- "format": "google-datetime",
- "description": "Time that this instance was started.@OutputOnly",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "qps": {
- "format": "float",
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "type": "number"
- },
- "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": {
- "description": "Rules to match an HTTP request and dispatch that request to a module.",
- "type": "object",
- "properties": {
- "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"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "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": {
- "name": {
- "description": "Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module."
- },
- "id": {
- "description": "Relative name of the module within the application. Example: default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Module"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested module.",
- "items": {
- "$ref": "Version"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "StaticDirectoryHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "format": "google-duration",
- "description": "Time a static file served by this handler should be cached.",
- "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": {
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "directory": {
- "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.",
- "type": "string"
- }
- },
- "id": "StaticDirectoryHandler"
- },
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
- "properties": {
- "cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- },
- "minPendingLatency": {
- "format": "google-duration",
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- },
- "maxIdleInstances": {
- "format": "int32",
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "type": "integer"
- },
- "requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
- },
- "minIdleInstances": {
- "format": "int32",
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
- "type": "integer"
- },
- "maxTotalInstances": {
- "format": "int32",
- "description": "Maximum number of instances that should be started to handle requests.",
- "type": "integer"
- },
- "minTotalInstances": {
- "format": "int32",
- "description": "Minimum number of instances that should be maintained for this version.",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "maxConcurrentRequests": {
- "format": "int32",
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "type": "integer"
- },
- "coolDownPeriod": {
- "format": "google-duration",
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "type": "string"
- },
- "maxPendingLatency": {
- "format": "google-duration",
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- }
- },
- "id": "AutomaticScaling"
- },
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReceivedBytesPerSec": {
- "format": "int32",
- "description": "Target bytes received per second.",
- "type": "integer"
- },
- "targetSentPacketsPerSec": {
- "format": "int32",
- "description": "Target packets sent per second.",
- "type": "integer"
- },
- "targetReceivedPacketsPerSec": {
- "format": "int32",
- "description": "Target packets received per second.",
- "type": "integer"
- },
- "targetSentBytesPerSec": {
- "format": "int32",
- "description": "Target bytes sent per second.",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "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"
}
},
"protocol": "rest",
@@ -2418,5 +2416,7 @@
"servicePath": "",
"description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"kind": "discovery#restDescription",
- "rootUrl": "https://appengine.googleapis.com/"
+ "rootUrl": "https://appengine.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com"
}
diff --git a/appengine/v1beta5/appengine-api.json b/appengine/v1beta5/appengine-api.json
index 8cca871..253c20b 100644
--- a/appengine/v1beta5/appengine-api.json
+++ b/appengine/v1beta5/appengine-api.json
@@ -1,32 +1,948 @@
{
+ "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"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "rootUrl": "https://appengine.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "appengine",
+ "batchPath": "batch",
+ "revision": "20170823",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1beta5",
+ "title": "Google App Engine Admin API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "resources": {
+ "apps": {
+ "methods": {
+ "patch": {
+ "flatPath": "v1beta5/apps/{appsId}",
+ "path": "v1beta5/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/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"
+ },
+ "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.",
+ "type": "string",
+ "required": true
+ },
+ "mask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "id": "appengine.apps.get",
+ "path": "v1beta5/apps/{appsId}",
+ "description": "Gets information about an application.",
+ "response": {
+ "$ref": "Application"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ },
+ "ensureResourcesExist": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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/).",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta5/apps",
+ "id": "appengine.apps.create",
+ "path": "v1beta5/apps"
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation resource.",
+ "type": "string",
+ "required": true
+ },
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "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."
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "path": "v1beta5/apps/{appsId}/operations",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "get": {
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get"
+ },
+ "list": {
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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}/locations",
+ "id": "appengine.apps.locations.list",
+ "path": "v1beta5/apps/{appsId}/locations",
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "services": {
+ "methods": {
+ "patch": {
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch",
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "servicesId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ },
+ "migrateTraffic": {
+ "location": "query",
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/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": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results."
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
+ "path": "v1beta5/apps/{appsId}/services",
+ "description": "Lists all the services in the application."
+ },
+ "get": {
+ "id": "appengine.apps.services.get",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "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": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "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/services/default.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete",
+ "description": "Deletes the specified service and all enclosed versions."
+ }
+ },
+ "resources": {
+ "versions": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "description": "Deletes an existing version."
+ },
+ "patch": {
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/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"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "type": "string",
+ "required": true
+ },
+ "mask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch"
+ },
+ "list": {
+ "description": "Lists the versions of a service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default."
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list"
+ },
+ "get": {
+ "id": "appengine.apps.services.versions.get",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
+ "response": {
+ "$ref": "Version"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string",
+ "location": "query"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1."
+ }
+ },
+ "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}"
+ },
+ "create": {
+ "id": "appengine.apps.services.versions.create",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Deploys new code and resource files to a new version.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions"
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "list": {
+ "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).",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1."
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.get",
+ "description": "Gets instance information."
+ },
+ "debug": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "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": {
+ "description": "Stops a running instance.",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\"."
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.delete",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.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"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ }
+ },
"schemas": {
"HealthCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"type": "object",
"properties": {
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "restartThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "type": "integer"
- },
- "healthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "type": "integer"
- },
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- },
"timeout": {
"format": "google-duration",
"description": "Time before the health check is considered failed.",
@@ -36,12 +952,34 @@
"format": "uint32",
"description": "Number of consecutive failed health checks required before removing traffic.",
"type": "integer"
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "healthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "type": "integer"
+ },
+ "restartThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "Interval between health checks."
}
},
"id": "HealthCheck"
},
"SourceReference": {
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
"type": "object",
"properties": {
"repository": {
@@ -53,7 +991,8 @@
"type": "string"
}
},
- "id": "SourceReference"
+ "id": "SourceReference",
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application."
},
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
@@ -66,10 +1005,36 @@
},
"id": "DebugInstanceRequest"
},
- "OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
"type": "object",
"properties": {
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ }
+ },
+ "id": "Library"
+ },
+ "OperationMetadataV1Beta5": {
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
@@ -78,39 +1043,14 @@
"format": "google-datetime",
"description": "Timestamp that this operation was created.@OutputOnly",
"type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation completed.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
}
},
- "id": "OperationMetadataV1Beta5"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- },
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- }
- },
- "id": "Library"
+ "id": "OperationMetadataV1Beta5",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
},
"ListLocationsResponse": {
+ "id": "ListLocationsResponse",
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
@@ -125,28 +1065,12 @@
"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"
+ }
},
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
"type": "object",
"properties": {
- "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"
@@ -210,8 +1134,8 @@
"type": "string"
},
"apiConfig": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
},
"endpointsApiService": {
"description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
@@ -226,6 +1150,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.",
@@ -235,9 +1161,7 @@
"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"
+ ]
},
"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",
@@ -254,6 +1178,7 @@
"inboundServices": {
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"items": {
+ "type": "string",
"enum": [
"INBOUND_SERVICE_UNSPECIFIED",
"INBOUND_SERVICE_MAIL",
@@ -264,8 +1189,7 @@
"INBOUND_SERVICE_XMPP_PRESENCE",
"INBOUND_SERVICE_CHANNEL_PRESENCE",
"INBOUND_SERVICE_WARMUP"
- ],
- "type": "string"
+ ]
},
"type": "array",
"enumDescriptions": [
@@ -309,12 +1233,27 @@
"type": "string"
},
"basicScaling": {
- "$ref": "BasicScaling",
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "$ref": "BasicScaling"
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
}
},
"id": "Version"
},
+ "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",
@@ -325,32 +1264,21 @@
"type": "integer"
},
"targetRequestCountPerSec": {
+ "type": "integer",
"format": "int32",
- "description": "Target requests per second.",
- "type": "integer"
+ "description": "Target requests per second."
}
},
"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": {
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "type": "string"
- },
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
- },
"UrlMap": {
"description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
"type": "object",
"properties": {
+ "urlRegex": {
+ "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
"login": {
"enumDescriptions": [
"Not specified. LOGIN_OPTIONAL is assumed.",
@@ -372,17 +1300,10 @@
"description": "Uses API Endpoints to handle requests."
},
"staticFiles": {
- "$ref": "StaticFilesHandler",
- "description": "Returns the contents of a file, such as an image, as the response."
+ "description": "Returns the contents of a file, such as an image, as the response.",
+ "$ref": "StaticFilesHandler"
},
"redirectHttpResponseCode": {
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ],
"enum": [
"REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
"REDIRECT_HTTP_RESPONSE_CODE_301",
@@ -391,58 +1312,14 @@
"REDIRECT_HTTP_RESPONSE_CODE_307"
],
"description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string"
- },
- "securityLevel": {
+ "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"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with an401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "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"
- }
- },
- "id": "UrlMap"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ]
},
"securityLevel": {
"enum": [
@@ -463,18 +1340,115 @@
]
},
"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",
+ "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": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
+ }
+ },
+ "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": {
+ "configId": {
+ "type": "string",
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\""
+ },
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
"type": "string"
+ }
+ },
+ "id": "EndpointsApiService"
+ },
+ "Operation": {
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object",
+ "properties": {
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object"
+ },
+ "name": {
+ "type": "string",
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name."
+ },
+ "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"
+ }
+ }
+ },
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "URL to serve the endpoint at."
+ },
+ "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 an401 HTTP status code and an error message."
+ ]
},
"script": {
"description": "Path to the script from the application root directory.",
@@ -499,43 +1473,7 @@
},
"id": "ApiConfigHandler"
},
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
"ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
"type": "object",
"properties": {
"scriptPath": {
@@ -543,28 +1481,33 @@
"type": "string"
}
},
- "id": "ScriptHandler"
+ "id": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches the URL pattern."
},
"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": {
+ "type": "boolean",
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist."
+ },
"expiration": {
"format": "google-duration",
"description": "Time a static file served by this handler should be cached.",
"type": "string"
},
- "httpHeaders": {
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
"applicationReadable": {
"description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
"type": "boolean"
},
+ "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"
@@ -574,12 +1517,8 @@
"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"
+ "type": "string",
+ "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."
}
},
"id": "StaticFilesHandler"
@@ -588,6 +1527,10 @@
"description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
"type": "object",
"properties": {
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ },
"sha1Sum": {
"description": "The SHA1 hash of the file, in hex.",
"type": "string"
@@ -595,42 +1538,13 @@
"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"
},
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetWriteBytesPerSec": {
- "format": "int32",
- "description": "Target bytes written per second.",
- "type": "integer"
- },
- "targetReadOpsPerSec": {
- "format": "int32",
- "description": "Target ops read per second.",
- "type": "integer"
- },
- "targetReadBytesPerSec": {
- "format": "int32",
- "description": "Target bytes read per second.",
- "type": "integer"
- },
- "targetWriteOpsPerSec": {
- "format": "int32",
- "description": "Target ops written per second.",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
"BasicScaling": {
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "type": "object",
"properties": {
"maxInstances": {
"format": "int32",
@@ -643,9 +1557,34 @@
"type": "string"
}
},
- "id": "BasicScaling",
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "type": "object"
+ "id": "BasicScaling"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReadBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes read per second.",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSec": {
+ "format": "int32",
+ "description": "Target ops written per second.",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes written per second.",
+ "type": "integer"
+ },
+ "targetReadOpsPerSec": {
+ "format": "int32",
+ "description": "Target ops read per second.",
+ "type": "integer"
+ }
+ },
+ "id": "DiskUtilization"
},
"OperationMetadataExperimental": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -677,7 +1616,6 @@
"id": "OperationMetadataExperimental"
},
"CpuUtilization": {
- "description": "Target scaling by CPU usage.",
"type": "object",
"properties": {
"aggregationWindowLength": {
@@ -691,16 +1629,13 @@
"type": "number"
}
},
- "id": "CpuUtilization"
+ "id": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
},
"IdentityAwareProxy": {
"description": "Identity-Aware Proxy",
"type": "object",
"properties": {
- "oauth2ClientSecret": {
- "description": "For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
- "type": "string"
- },
"oauth2ClientId": {
"description": "OAuth2 client ID to use for the authentication flow.",
"type": "string"
@@ -712,6 +1647,10 @@
"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"
}
},
"id": "IdentityAwareProxy"
@@ -723,11 +1662,11 @@
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "type": "object"
+ }
},
"type": "array"
},
@@ -744,14 +1683,17 @@
"id": "Status"
},
"TrafficSplit": {
+ "id": "TrafficSplit",
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "type": "object",
"properties": {
"allocations": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
"description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object"
+ "type": "object",
+ "additionalProperties": {
+ "type": "number",
+ "format": "double"
+ }
},
"shardBy": {
"enumDescriptions": [
@@ -767,10 +1709,7 @@
"description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
"type": "string"
}
- },
- "id": "TrafficSplit",
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
- "type": "object"
+ }
},
"ManualScaling": {
"description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
@@ -803,29 +1742,29 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"insertTime": {
"format": "google-datetime",
"description": "Time that this operation was created.@OutputOnly",
"type": "string"
},
+ "warning": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Durable messages that persist on every operation poll. @OutputOnly"
+ },
"target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly"
},
"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"
+ "type": "string",
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly"
},
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
@@ -840,8 +1779,6 @@
"id": "OperationMetadataV1Beta"
},
"ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -855,17 +1792,15 @@
"type": "array"
}
},
- "id": "ListServicesResponse"
+ "id": "ListServicesResponse",
+ "description": "Response message for Services.ListServices.",
+ "type": "object"
},
"Deployment": {
+ "id": "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"
- },
"sourceReferences": {
"description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
"items": {
@@ -874,18 +1809,32 @@
"type": "array"
},
"container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ },
+ "files": {
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ }
}
- },
- "id": "Deployment",
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object"
+ }
},
"Resources": {
"description": "Machine resources for a version.",
"type": "object",
"properties": {
+ "memoryGb": {
+ "format": "double",
+ "description": "Memory (GB) needed.",
+ "type": "number"
+ },
+ "cpu": {
+ "type": "number",
+ "format": "double",
+ "description": "Number of CPU cores needed."
+ },
"volumes": {
"description": "Volumes mounted within the app container.",
"items": {
@@ -897,16 +1846,6 @@
"format": "double",
"description": "Disk size (GB) needed.",
"type": "number"
- },
- "memoryGb": {
- "format": "double",
- "description": "Memory (GB) needed.",
- "type": "number"
- },
- "cpu": {
- "format": "double",
- "description": "Number of CPU cores needed.",
- "type": "number"
}
},
"id": "Resources"
@@ -916,16 +1855,16 @@
"type": "object",
"properties": {
"split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
+ "$ref": "TrafficSplit"
},
"id": {
"description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
},
"name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly"
}
},
"id": "Service"
@@ -954,16 +1893,16 @@
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListOperationsResponse"
@@ -972,36 +1911,37 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "endTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation completed.@OutputOnly",
- "type": "string"
- },
"operationType": {
"description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
"type": "string"
},
"insertTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "Timestamp that this operation was created.@OutputOnly",
+ "description": "Timestamp that this operation was created.@OutputOnly"
+ },
+ "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"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
"type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "type": "string"
}
},
"id": "OperationMetadata"
},
"ListInstancesResponse": {
+ "id": "ListInstancesResponse",
"description": "Response message for Instances.ListInstances.",
"type": "object",
"properties": {
@@ -1016,48 +1956,7 @@
},
"type": "array"
}
- },
- "id": "ListInstancesResponse"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
+ }
},
"ErrorHandler": {
"description": "Custom static error page to be served when an error occurs.",
@@ -1068,6 +1967,8 @@
"type": "string"
},
"errorCode": {
+ "description": "Error condition this handler applies to.",
+ "type": "string",
"enumDescriptions": [
"Not specified. ERROR_CODE_DEFAULT is assumed.",
"All other error types.",
@@ -1081,9 +1982,7 @@
"ERROR_CODE_OVER_QUOTA",
"ERROR_CODE_DOS_API_DENIAL",
"ERROR_CODE_TIMEOUT"
- ],
- "description": "Error condition this handler applies to.",
- "type": "string"
+ ]
},
"staticFile": {
"description": "Static file content to be served for this error.",
@@ -1092,27 +1991,49 @@
},
"id": "ErrorHandler"
},
- "OperationMetadataV1Alpha": {
+ "OperationMetadataV1": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
"endTime": {
"format": "google-datetime",
"description": "Time that this operation completed.@OutputOnly",
"type": "string"
},
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
"type": "string"
},
"type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
+ "OperationMetadataV1Alpha": {
+ "type": "object",
+ "properties": {
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
@@ -1128,11 +2049,81 @@
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
"type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "OperationMetadataV1Alpha"
+ "id": "OperationMetadataV1Alpha",
+ "description": "Metadata for the given google.longrunning.Operation."
+ },
+ "Application": {
+ "type": "object",
+ "properties": {
+ "codeBucket": {
+ "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "location": {
+ "type": "string",
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US"
+ },
+ "defaultBucket": {
+ "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
+ "type": "string"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ },
+ "type": "array"
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "authDomain": {
+ "type": "string",
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account."
+ },
+ "id": {
+ "type": "string",
+ "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."
+ },
+ "defaultCookieExpiration": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "Cookie expiration policy for this application."
+ }
+ },
+ "id": "Application",
+ "description": "An Application resource contains the top-level configuration of an App Engine application."
},
"Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "type": "object",
"properties": {
"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.",
@@ -1154,72 +2145,43 @@
"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": {
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "format": "google-duration",
- "description": "Cookie expiration policy for this application.",
- "type": "string"
- },
- "codeBucket": {
- "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "defaultBucket": {
- "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
- "items": {
- "$ref": "UrlDispatchRule"
- },
- "type": "array"
- },
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Application"
+ "id": "Network"
},
"Instance": {
"description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
"type": "object",
"properties": {
+ "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": {
+ "format": "uint32",
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "type": "integer"
+ },
"requests": {
"format": "int32",
"description": "Number of requests since this instance was started.@OutputOnly",
"type": "integer"
},
"appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "App Engine release this instance is running on.@OutputOnly"
},
"startTimestamp": {
"format": "google-datetime",
@@ -1230,23 +2192,23 @@
"description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
"qps": {
"format": "float",
"description": "Average queries per second (QPS) over the last minute.@OutputOnly",
"type": "number"
},
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
+ "vmUnlocked": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
},
"name": {
"description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
"type": "string"
},
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
"vmZoneName": {
"description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
@@ -1256,8 +2218,8 @@
"description": "Average latency (ms) over the last minute.@OutputOnly",
"type": "integer"
},
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
"memoryUsage": {
@@ -1265,42 +2227,17 @@
"description": "Total memory in use (bytes).@OutputOnly",
"type": "string"
},
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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": {
- "format": "uint32",
- "description": "Number of errors since this instance was started.@OutputOnly",
- "type": "integer"
}
},
"id": "Instance"
},
"UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "type": "object",
"properties": {
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- },
"service": {
"description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
"type": "string"
@@ -1308,13 +2245,16 @@
"domain": {
"description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
"type": "string"
+ },
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
}
},
- "id": "UrlDispatchRule",
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object"
+ "id": "UrlDispatchRule"
},
"ListVersionsResponse": {
+ "id": "ListVersionsResponse",
"description": "Response message for Versions.ListVersions.",
"type": "object",
"properties": {
@@ -1329,39 +2269,24 @@
"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"
+ "type": "string",
+ "description": "Path to the script from the application root directory."
}
},
"id": "ApiEndpointHandler"
},
"AutomaticScaling": {
+ "id": "AutomaticScaling",
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
"type": "object",
"properties": {
- "minIdleInstances": {
- "format": "int32",
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
- "type": "integer"
- },
- "maxTotalInstances": {
- "format": "int32",
- "description": "Maximum number of instances that should be started to handle requests.",
- "type": "integer"
- },
- "minTotalInstances": {
- "format": "int32",
- "description": "Minimum number of instances that should be maintained for this version.",
- "type": "integer"
- },
"networkUtilization": {
"description": "Target scaling by network usage.",
"$ref": "NetworkUtilization"
@@ -1400,11 +2325,25 @@
"type": "integer"
},
"requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "minIdleInstances": {
+ "format": "int32",
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Minimum number of instances that should be maintained for this version."
}
- },
- "id": "AutomaticScaling"
+ }
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
@@ -1437,8 +2376,6 @@
"id": "Location"
},
"NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
"properties": {
"targetReceivedBytesPerSec": {
"format": "int32",
@@ -1461,951 +2398,14 @@
"type": "integer"
}
},
- "id": "NetworkUtilization"
+ "id": "NetworkUtilization",
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "version": "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"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "servicePath": "",
- "rootUrl": "https://appengine.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "appengine",
- "batchPath": "batch",
- "id": "appengine:v1beta5",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170811",
- "title": "Google App Engine Admin API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "resources": {
- "apps": {
- "methods": {
- "patch": {
- "request": {
- "$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "type": "string",
- "required": true
- },
- "mask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1beta5/apps/{appsId}"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Application"
- },
- "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. Note: This parameter will be deprecated in a future version of the API.",
- "type": "boolean",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta5/apps/{appsId}",
- "path": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.get",
- "description": "Gets information about an application."
- },
- "create": {
- "request": {
- "$ref": "Application"
- },
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta5/apps",
- "id": "appengine.apps.create",
- "path": "v1beta5/apps"
- }
- },
- "resources": {
- "locations": {
- "methods": {
- "get": {
- "description": "Get information about a location.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "type": "string",
- "required": true
- },
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "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}/locations/{locationsId}",
- "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
- },
- "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": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "path": "v1beta5/apps/{appsId}/locations"
- }
- }
- },
- "services": {
- "methods": {
- "delete": {
- "description": "Deletes the specified service and all enclosed versions.",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "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`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}"
- },
- "patch": {
- "request": {
- "$ref": "Service"
- },
- "description": "Updates the configuration of the specified service.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "migrateTraffic": {
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/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": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}"
- },
- "list": {
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
- "path": "v1beta5/apps/{appsId}/services",
- "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": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}"
- }
- },
- "resources": {
- "versions": {
- "resources": {
- "instances": {
- "methods": {
- "debug": {
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "request": {
- "$ref": "DebugInstanceRequest"
- }
- },
- "delete": {
- "description": "Stops a running instance.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\".",
- "type": "string",
- "required": true
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete"
- },
- "list": {
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list"
- },
- "get": {
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Instance"
- },
- "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": {
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information."
- }
- }
- }
- },
- "methods": {
- "delete": {
- "description": "Deletes an existing version.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "patch": {
- "id": "appengine.apps.services.versions.patch",
- "path": "v1beta5/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/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "type": "string",
- "required": true
- },
- "mask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "list": {
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "description": "Controls the set of fields returned in the List response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "description": "Lists the versions of a service."
- },
- "get": {
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
- },
- "create": {
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys new code and resource files to a new version.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "path": "v1beta5/apps/{appsId}/operations/{operationsId}"
- },
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "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"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/operations",
- "path": "v1beta5/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "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"
- }
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
}
}
diff --git a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
index dd184dc..bc04798 100644
--- a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
+++ b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
@@ -6,79 +6,69 @@
"ownerName": "Google",
"resources": {
"projects": {
+ "methods": {
+ "isEnabled": {
+ "flatPath": "v1/projects/{projectsId}:isEnabled",
+ "path": "v1/{+name}:isEnabled",
+ "id": "bigquerydatatransfer.projects.isEnabled",
+ "request": {
+ "$ref": "IsEnabledRequest"
+ },
+ "description": "Returns true if data transfer is enabled for a project.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "IsEnabledResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the project resource in the form:\n`projects/{project_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "setEnabled": {
+ "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.",
+ "request": {
+ "$ref": "SetEnabledRequest"
+ },
+ "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}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}:setEnabled",
+ "path": "v1/{+name}:setEnabled",
+ "id": "bigquerydatatransfer.projects.setEnabled"
+ }
+ },
"resources": {
"locations": {
"methods": {
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "Resource name for the location.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.get",
- "description": "Get information about a location.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ]
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations",
- "path": "v1/{+name}/locations",
- "id": "bigquerydatatransfer.projects.locations.list",
- "description": "Lists information about the supported locations for this service."
- },
"isEnabled": {
"description": "Returns true if data transfer is enabled for a project.",
"request": {
@@ -93,11 +83,11 @@
"httpMethod": "POST",
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
"description": "The name of the project resource in the form:\n`projects/{project_id}`",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -110,12 +100,13 @@
"path": "v1/{+name}:isEnabled"
},
"setEnabled": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setEnabled",
"id": "bigquerydatatransfer.projects.locations.setEnabled",
"path": "v1/{+name}:setEnabled",
+ "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.",
"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.",
"response": {
"$ref": "Empty"
},
@@ -123,9 +114,6 @@
"name"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"description": "The name of the project resource in the form:\n`projects/{project_id}`",
@@ -135,87 +123,318 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setEnabled"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Resource name for the location.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.get"
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "id": "bigquerydatatransfer.projects.locations.list",
+ "path": "v1/{+name}/locations"
}
},
"resources": {
"transferConfigs": {
- "resources": {
- "runs": {
- "resources": {
- "transferLogs": {
- "methods": {
- "list": {
- "description": "Returns user facing log messages for the data transfer run.",
- "response": {
- "$ref": "ListTransferLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
- "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "type": "integer",
- "location": "query"
- },
- "messageTypes": {
- "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "MESSAGE_SEVERITY_UNSPECIFIED",
- "INFO",
- "WARNING",
- "ERROR"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
- "path": "v1/{+parent}/transferLogs"
- }
- }
+ "methods": {
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "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}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Returns information about all data transfers in the project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "dataSourceIds": {
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.list"
+ },
+ "create": {
+ "description": "Creates a new data transfer configuration.",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "authorizationCode": {
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
+ "path": "v1/{+parent}/transferConfigs"
+ },
+ "scheduleRuns": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
+ "path": "v1/{+parent}:scheduleRuns",
+ "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ },
+ "response": {
+ "$ref": "ScheduleTransferRunsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required list of fields to be updated in this request.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
+ },
+ "authorizationCode": {
+ "location": "query",
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.locations.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",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.get",
+ "path": "v1/{+name}"
+ }
+ },
+ "resources": {
+ "runs": {
"methods": {
"list": {
- "description": "Returns information about running and completed jobs.",
- "response": {
- "$ref": "ListTransferRunsResponse"
- },
"parameterOrder": [
"parent"
],
+ "response": {
+ "$ref": "ListTransferRunsResponse"
+ },
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string",
+ "location": "query"
+ },
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"statuses": {
+ "description": "When specified, only transfer runs with requested statuses are returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
"enum": [
"TRANSFER_STATUS_UNSPECIFIED",
"INACTIVE",
@@ -224,47 +443,31 @@
"SUCCEEDED",
"FAILED",
"CANCELLED"
- ],
- "description": "When specified, only transfer runs with requested statuses are returned.",
- "type": "string",
- "repeated": true,
- "location": "query"
+ ]
},
"runAttempt": {
+ "description": "Indicates how run attempts are to be pulled.",
+ "type": "string",
"location": "query",
"enum": [
"RUN_ATTEMPT_UNSPECIFIED",
"LATEST"
- ],
- "description": "Indicates how run attempts are to be pulled.",
- "type": "string"
+ ]
},
"parent": {
- "location": "path",
"description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
- },
- "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"
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
- "path": "v1/{+parent}/runs"
+ "path": "v1/{+parent}/runs",
+ "description": "Returns information about running and completed jobs."
},
"get": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
- "path": "v1/{+name}",
"description": "Returns information about the particular transfer run.",
"response": {
"$ref": "TransferRun"
@@ -286,16 +489,24 @@
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
+ "path": "v1/{+name}"
},
"delete": {
- "response": {
- "$ref": "Empty"
- },
+ "description": "Deletes the specified transfer run.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
@@ -305,278 +516,92 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
"path": "v1/{+name}",
- "description": "Deletes the specified transfer run."
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete"
+ }
+ },
+ "resources": {
+ "transferLogs": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "type": "integer"
+ },
+ "messageTypes": {
+ "location": "query",
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
+ "type": "string",
+ "repeated": true
+ },
+ "parent": {
+ "location": "path",
+ "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
+ "path": "v1/{+parent}/transferLogs",
+ "description": "Returns user facing log messages for the data transfer run."
+ }
+ }
}
}
}
- },
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
- "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs."
- },
- "list": {
- "description": "Returns information about all data transfers in the project.",
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "dataSourceIds": {
- "description": "When specified, only configurations of requested data sources are returned.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- },
- "pageToken": {
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
- "path": "v1/{+parent}/transferConfigs"
- },
- "create": {
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "authorizationCode": {
- "location": "query",
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string"
- },
- "parent": {
- "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
- "path": "v1/{+parent}/transferConfigs",
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Creates a new data transfer configuration."
- },
- "scheduleRuns": {
- "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
- "request": {
- "$ref": "ScheduleTransferRunsRequest"
- },
- "response": {
- "$ref": "ScheduleTransferRunsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
- "path": "v1/{+parent}:scheduleRuns"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "TransferConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.get",
- "description": "Returns information about a data transfer config."
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "TransferConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the transfer 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.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- },
- "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": {
- "format": "google-fieldmask",
- "description": "Required list of fields to be updated in this request.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch",
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated."
- }
}
},
"dataSources": {
"methods": {
- "checkValidCreds": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CheckValidCredsResponse"
- },
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
- "location": "path",
- "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds",
- "path": "v1/{+name}:checkValidCreds",
- "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
- "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.",
- "request": {
- "$ref": "CheckValidCredsRequest"
- }
- },
"list": {
"description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "ListDataSourcesResponse"
},
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "pageToken": {
- "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"parent": {
"description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
@@ -584,270 +609,89 @@
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources",
- "path": "v1/{+parent}/dataSources",
- "id": "bigquerydatatransfer.projects.locations.dataSources.list"
+ "id": "bigquerydatatransfer.projects.locations.dataSources.list",
+ "path": "v1/{+parent}/dataSources"
},
"get": {
"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}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.get"
+ },
+ "checkValidCreds": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
+ "path": "v1/{+name}:checkValidCreds",
+ "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.",
+ "request": {
+ "$ref": "CheckValidCredsRequest"
+ },
+ "response": {
+ "$ref": "CheckValidCredsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"parameters": {
"name": {
+ "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`"
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
- "id": "bigquerydatatransfer.projects.locations.dataSources.get",
- "path": "v1/{+name}"
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
}
}
}
}
},
"transferConfigs": {
- "resources": {
- "runs": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
- "description": "Deletes the specified transfer run."
- },
- "list": {
- "description": "Returns information about running and completed jobs.",
- "response": {
- "$ref": "ListTransferRunsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "parent": {
- "type": "string",
- "required": true,
- "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": {
- "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"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "type": "integer"
- },
- "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
- },
- "runAttempt": {
- "location": "query",
- "enum": [
- "RUN_ATTEMPT_UNSPECIFIED",
- "LATEST"
- ],
- "description": "Indicates how run attempts are to be pulled.",
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
- "path": "v1/{+parent}/runs"
- },
- "get": {
- "description": "Returns information about the particular transfer run.",
- "response": {
- "$ref": "TransferRun"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
- "path": "v1/{+name}"
- }
- },
- "resources": {
- "transferLogs": {
- "methods": {
- "list": {
- "description": "Returns user facing log messages for the data transfer run.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListTransferLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
- "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Page size. The default page size is the maximum value of 1000 results."
- },
- "messageTypes": {
- "repeated": true,
- "location": "query",
- "enum": [
- "MESSAGE_SEVERITY_UNSPECIFIED",
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
- "path": "v1/{+parent}/transferLogs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list"
- }
- }
- }
- }
- }
- },
"methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "type": "string",
- "required": true,
- "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."
- },
"list": {
- "id": "bigquerydatatransfer.projects.transferConfigs.list",
- "path": "v1/{+parent}/transferConfigs",
- "description": "Returns information about all data transfers in the project.",
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
- },
"pageSize": {
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
@@ -861,16 +705,36 @@
"repeated": true
},
"parent": {
- "pattern": "^projects/[^/]+$",
"location": "path",
"description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/transferConfigs"
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.list",
+ "description": "Returns information about all data transfers in the project."
},
"create": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.create",
+ "path": "v1/{+parent}/transferConfigs",
+ "description": "Creates a new data transfer configuration.",
+ "request": {
+ "$ref": "TransferConfig"
+ },
"response": {
"$ref": "TransferConfig"
},
@@ -878,10 +742,6 @@
"parent"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"authorizationCode": {
"location": "query",
@@ -889,22 +749,23 @@
"type": "string"
},
"parent": {
+ "location": "path",
+ "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region."
+ "pattern": "^projects/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/transferConfigs",
- "id": "bigquerydatatransfer.projects.transferConfigs.create",
- "path": "v1/{+parent}/transferConfigs",
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Creates a new data transfer configuration."
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"scheduleRuns": {
+ "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ },
"response": {
"$ref": "ScheduleTransferRunsResponse"
},
@@ -914,11 +775,11 @@
"httpMethod": "POST",
"parameters": {
"parent": {
- "location": "path",
"description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -927,39 +788,29 @@
],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
"id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns",
- "path": "v1/{+parent}:scheduleRuns",
- "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
- "request": {
- "$ref": "ScheduleTransferRunsRequest"
- }
+ "path": "v1/{+parent}:scheduleRuns"
},
"patch": {
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.patch",
- "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
- "request": {
- "$ref": "TransferConfig"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "TransferConfig"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
"parameters": {
"updateMask": {
- "location": "query",
"format": "google-fieldmask",
"description": "Required list of fields to be updated in this request.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"name": {
- "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.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
},
"authorizationCode": {
"description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
@@ -971,9 +822,18 @@
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}"
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.patch",
+ "path": "v1/{+name}",
+ "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "request": {
+ "$ref": "TransferConfig"
+ }
},
"get": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.get",
"description": "Returns information about a data transfer config.",
"httpMethod": "GET",
"parameterOrder": [
@@ -984,10 +844,279 @@
},
"parameters": {
"name": {
+ "location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.delete",
+ "path": "v1/{+name}"
+ }
+ },
+ "resources": {
+ "runs": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
+ "description": "Deletes the specified transfer run.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Returns information about running and completed jobs.",
+ "response": {
+ "$ref": "ListTransferRunsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "statuses": {
+ "description": "When specified, only transfer runs with requested statuses are returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "TRANSFER_STATUS_UNSPECIFIED",
+ "INACTIVE",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ]
+ },
+ "runAttempt": {
+ "location": "query",
+ "enum": [
+ "RUN_ATTEMPT_UNSPECIFIED",
+ "LATEST"
+ ],
+ "description": "Indicates how run attempts are to be pulled.",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
+ "path": "v1/{+parent}/runs"
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
+ "path": "v1/{+name}",
+ "description": "Returns information about the particular transfer run.",
+ "response": {
+ "$ref": "TransferRun"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path"
+ }
+ }
+ }
+ },
+ "resources": {
+ "transferLogs": {
+ "methods": {
+ "list": {
+ "description": "Returns user facing log messages for the data transfer run.",
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "messageTypes": {
+ "location": "query",
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
+ "type": "string",
+ "repeated": true
+ },
+ "parent": {
+ "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
+ "path": "v1/{+parent}/transferLogs"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "dataSources": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListDataSourcesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/dataSources",
+ "id": "bigquerydatatransfer.projects.dataSources.list",
+ "path": "v1/{+parent}/dataSources",
+ "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering."
+ },
+ "get": {
+ "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "DataSource"
+ },
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$",
"location": "path"
}
},
@@ -996,82 +1125,11 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.get"
- }
- }
- },
- "dataSources": {
- "methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "type": "integer"
- }
- },
- "flatPath": "v1/projects/{projectsId}/dataSources",
- "id": "bigquerydatatransfer.projects.dataSources.list",
- "path": "v1/{+parent}/dataSources",
- "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
- "response": {
- "$ref": "ListDataSourcesResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ]
- },
- "get": {
- "response": {
- "$ref": "DataSource"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/dataSources/[^/]+$"
- }
- },
"flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
- "id": "bigquerydatatransfer.projects.dataSources.get",
"path": "v1/{+name}",
- "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering."
+ "id": "bigquerydatatransfer.projects.dataSources.get"
},
"checkValidCreds": {
- "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
- "path": "v1/{+name}:checkValidCreds",
"description": "Returns true if valid credentials exist for the given data source and\nrequesting user.",
"request": {
"$ref": "CheckValidCredsRequest"
@@ -1085,11 +1143,11 @@
"httpMethod": "POST",
"parameters": {
"name": {
+ "location": "path",
+ "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/dataSources/[^/]+$",
- "location": "path",
- "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`"
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$"
}
},
"scopes": [
@@ -1097,93 +1155,19 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds"
+ "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds",
+ "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
+ "path": "v1/{+name}:checkValidCreds"
}
}
}
- },
- "methods": {
- "isEnabled": {
- "response": {
- "$ref": "IsEnabledResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "description": "The name of the project resource in the form:\n`projects/{project_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}:isEnabled",
- "id": "bigquerydatatransfer.projects.isEnabled",
- "path": "v1/{+name}:isEnabled",
- "request": {
- "$ref": "IsEnabledRequest"
- },
- "description": "Returns true if data transfer is enabled for a project."
- },
- "setEnabled": {
- "path": "v1/{+name}:setEnabled",
- "id": "bigquerydatatransfer.projects.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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the project resource in the form:\n`projects/{project_id}`"
- }
- },
- "flatPath": "v1/projects/{projectsId}:setEnabled"
- }
}
}
},
"parameters": {
- "upload_protocol": {
+ "callback": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "JSONP",
"type": "string"
},
"$.xgafv": {
@@ -1199,26 +1183,21 @@
"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"
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"access_token": {
"description": "OAuth access token.",
@@ -1226,9 +1205,9 @@
"location": "query"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
"location": "query",
@@ -1236,34 +1215,497 @@
"type": "string"
},
"pp": {
- "default": "true",
- "type": "boolean",
"location": "query",
- "description": "Pretty-print response."
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
}
},
"version": "v1",
"baseUrl": "https://bigquerydatatransfer.googleapis.com/",
- "servicePath": "",
"description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
"kind": "discovery#restDescription",
+ "servicePath": "",
"basePath": "",
- "revision": "20170822",
- "documentationLink": "https://cloud.google.com/bigquery/",
"id": "bigquerydatatransfer:v1",
+ "documentationLink": "https://cloud.google.com/bigquery/",
+ "revision": "20170822",
"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"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Location"
+ },
+ "TransferConfig": {
+ "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.",
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
+ "type": "boolean"
+ },
+ "nextRunTime": {
+ "format": "google-datetime",
+ "description": "Next time when data transfer will run. Output only. Applicable\nonly for batch data transfers.\n@OutputOnly",
+ "type": "string"
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly",
+ "type": "string"
+ },
+ "schedule": {
+ "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
+ "type": "string"
+ },
+ "dataRefreshWindowDays": {
+ "format": "int32",
+ "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
+ "type": "integer"
+ },
+ "dataSourceId": {
+ "description": "Data source id. Cannot be changed once data transfer is created.",
+ "type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Status placeholder.",
+ "Data transfer is inactive.",
+ "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
+ "Data transfer is in progress.",
+ "Data transfer completed successsfully.",
+ "Data transfer failed.",
+ "Data transfer is cancelled."
+ ],
+ "enum": [
+ "TRANSFER_STATUS_UNSPECIFIED",
+ "INACTIVE",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "Status of the most recently updated transfer run.\n@OutputOnly",
+ "type": "string"
+ },
+ "destinationDatasetId": {
+ "description": "The BigQuery target dataset id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/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.",
+ "type": "string"
+ },
+ "userId": {
+ "format": "int64",
+ "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",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Data transfer specific parameters.",
+ "type": "object"
+ },
+ "datasetRegion": {
+ "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "User specified display name for the data transfer.",
+ "type": "string"
+ }
+ },
+ "id": "TransferConfig"
+ },
+ "TransferRun": {
+ "description": "Represents a data transfer run.",
+ "type": "object",
+ "properties": {
+ "params": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Data transfer specific parameters.",
+ "type": "object"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time when transfer run ended. Parameter ignored by server for input\nrequests.\n@OutputOnly",
+ "type": "string"
+ },
+ "datasetRegion": {
+ "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Time when transfer run was started. Parameter ignored by server for input\nrequests.\n@OutputOnly",
+ "type": "string"
+ },
+ "scheduleTime": {
+ "format": "google-datetime",
+ "description": "Minimum time after which a transfer run can be started.",
+ "type": "string"
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "Last time the data transfer run status was updated.\n@OutputOnly",
+ "type": "string"
+ },
+ "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"
+ },
+ "runTime": {
+ "format": "google-datetime",
+ "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
+ "type": "string"
+ },
+ "dataSourceId": {
+ "description": "Data source id.\n@OutputOnly",
+ "type": "string"
+ },
+ "status": {
+ "description": "Data transfer run status. Ignored for input requests.\n@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "Status placeholder.",
+ "Data transfer is inactive.",
+ "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
+ "Data transfer is in progress.",
+ "Data transfer completed successsfully.",
+ "Data transfer failed.",
+ "Data transfer is cancelled."
+ ],
+ "enum": [
+ "TRANSFER_STATUS_UNSPECIFIED",
+ "INACTIVE",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ]
+ },
+ "userId": {
+ "format": "int64",
+ "description": "The user id for this transfer run.\n@OutputOnly",
+ "type": "string"
+ },
+ "destinationDatasetId": {
+ "description": "The BigQuery target dataset id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
+ "type": "string"
+ }
+ },
+ "id": "TransferRun"
+ },
+ "CheckValidCredsRequest": {
+ "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
+ "type": "object",
+ "properties": {},
+ "id": "CheckValidCredsRequest"
+ },
+ "CheckValidCredsResponse": {
+ "description": "A response indicating whether the credentials exist and are valid.",
+ "type": "object",
+ "properties": {
+ "hasValidCreds": {
+ "description": "If set to `true`, the credentials exist and are valid.",
+ "type": "boolean"
+ }
+ },
+ "id": "CheckValidCredsResponse"
+ },
+ "ScheduleTransferRunsResponse": {
+ "description": "A response to schedule transfer runs for a time range.",
+ "type": "object",
+ "properties": {
+ "createdRuns": {
+ "description": "The transfer runs that were created.",
+ "items": {
+ "$ref": "TransferRun"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ScheduleTransferRunsResponse"
+ },
+ "ListTransferLogsResponse": {
+ "description": "The returned list transfer run messages.",
+ "type": "object",
+ "properties": {
+ "transferMessages": {
+ "description": "The stored pipeline transfer messages.\n@OutputOnly",
+ "items": {
+ "$ref": "TransferMessage"
+ },
+ "type": "array"
+ },
+ "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": {
+ "messageText": {
+ "description": "Message text.",
+ "type": "string"
+ },
+ "severity": {
+ "description": "Message severity.",
+ "type": "string",
+ "enumDescriptions": [
+ "No severity specified.",
+ "Informational message.",
+ "Warning message.",
+ "Error message."
+ ],
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ]
+ },
+ "messageTime": {
+ "format": "google-datetime",
+ "description": "Time when message was logged.",
+ "type": "string"
+ }
+ },
+ "id": "TransferMessage"
+ },
+ "ListDataSourcesResponse": {
+ "description": "Returns list of supported data sources and their metadata.",
+ "type": "object",
+ "properties": {
+ "dataSources": {
+ "description": "List of supported data sources and their transfer settings.",
+ "items": {
+ "$ref": "DataSource"
+ },
+ "type": "array"
+ },
+ "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"
+ }
+ },
+ "id": "ListDataSourcesResponse"
+ },
+ "DataSourceParameter": {
+ "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Parameter description.",
+ "type": "string"
+ },
+ "allowedValues": {
+ "description": "All possible values for the parameter.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "validationHelpUrl": {
+ "description": "URL to a help document to further explain the naming requirements.",
+ "type": "string"
+ },
+ "minValue": {
+ "format": "double",
+ "description": "For integer and double values specifies minimum allowed value.",
+ "type": "number"
+ },
+ "validationRegex": {
+ "description": "Regular expression which can be used for parameter validation.",
+ "type": "string"
+ },
+ "paramId": {
+ "description": "Parameter identifier.",
+ "type": "string"
+ },
+ "required": {
+ "description": "Is parameter required.",
+ "type": "boolean"
+ },
+ "repeated": {
+ "description": "Can parameter have multiple values.",
+ "type": "boolean"
+ },
+ "displayName": {
+ "description": "Parameter display name in the user interface.",
+ "type": "string"
+ },
+ "immutable": {
+ "description": "Cannot be changed after initial creation.",
+ "type": "boolean"
+ },
+ "validationDescription": {
+ "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.",
+ "type": "string"
+ },
+ "fields": {
+ "description": "When parameter is a record, describes child fields.",
+ "items": {
+ "$ref": "DataSourceParameter"
+ },
+ "type": "array"
+ },
+ "maxValue": {
+ "format": "double",
+ "description": "For integer and double values specifies maxminum allowed value.",
+ "type": "number"
+ },
+ "type": {
+ "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."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "STRING",
+ "INTEGER",
+ "DOUBLE",
+ "BOOLEAN",
+ "RECORD",
+ "PLUS_PAGE"
+ ],
+ "description": "Parameter type.",
+ "type": "string"
+ },
+ "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"
+ },
+ "ListTransferRunsResponse": {
+ "description": "The returned list of pipelines in the project.",
+ "type": "object",
+ "properties": {
+ "transferRuns": {
+ "description": "The stored pipeline transfer runs.\n@OutputOnly",
+ "items": {
+ "$ref": "TransferRun"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "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",
@@ -1276,6 +1718,8 @@
"id": "SetEnabledRequest"
},
"ListTransferConfigsResponse": {
+ "description": "The returned list of pipelines in the project.",
+ "type": "object",
"properties": {
"transferConfigs": {
"description": "The stored pipeline transfer configurations.\n@OutputOnly",
@@ -1289,12 +1733,9 @@
"type": "string"
}
},
- "id": "ListTransferConfigsResponse",
- "description": "The returned list of pipelines in the project.",
- "type": "object"
+ "id": "ListTransferConfigsResponse"
},
"IsEnabledResponse": {
- "id": "IsEnabledResponse",
"description": "A response to indicate whether data transfer is enabled for the project.",
"type": "object",
"properties": {
@@ -1302,39 +1743,13 @@
"description": "Indicates whether the project is enabled.",
"type": "boolean"
}
- }
+ },
+ "id": "IsEnabledResponse"
},
"DataSource": {
- "id": "DataSource",
"description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
"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"
- },
- "displayName": {
- "description": "User friendly data source name.",
- "type": "string"
- },
"dataRefreshType": {
"enumDescriptions": [
"The data source won't support data auto refresh, which is default value.",
@@ -1373,18 +1788,16 @@
"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"
+ },
"defaultDataRefreshWindowDays": {
"format": "int32",
"description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
"type": "integer"
},
- "manualRunsDisabled": {
- "description": "Disables backfilling and manual run scheduling\nfor the data source.",
- "type": "boolean"
- },
"transferType": {
- "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.",
- "type": "string",
"enumDescriptions": [
"Invalid or Unknown transfer type placeholder.",
"Batch data transfer.",
@@ -1394,7 +1807,9 @@
"TRANSFER_TYPE_UNSPECIFIED",
"BATCH",
"STREAMING"
- ]
+ ],
+ "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.",
+ "type": "string"
},
"description": {
"description": "User friendly data source description string.",
@@ -1414,8 +1829,35 @@
"type": "string"
},
"type": "array"
+ },
+ "clientId": {
+ "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
+ "type": "string"
+ },
+ "authorizationType": {
+ "description": "Indicates the type of authorization.",
+ "type": "string",
+ "enumDescriptions": [
+ "Type unspecified.",
+ "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
+ "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
+ ],
+ "enum": [
+ "AUTHORIZATION_TYPE_UNSPECIFIED",
+ "AUTHORIZATION_CODE",
+ "GOOGLE_PLUS_AUTHORIZATION_CODE"
+ ]
+ },
+ "supportsCustomSchedule": {
+ "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.",
+ "type": "boolean"
+ },
+ "displayName": {
+ "description": "User friendly data source name.",
+ "type": "string"
}
- }
+ },
+ "id": "DataSource"
},
"ScheduleTransferRunsRequest": {
"description": "A request to schedule transfer runs for a time range.",
@@ -1427,454 +1869,12 @@
"type": "string"
},
"rangeEndTime": {
- "type": "string",
"format": "google-datetime",
- "description": "End time of the range of transfer runs."
+ "description": "End time of the range of transfer runs.",
+ "type": "string"
}
},
"id": "ScheduleTransferRunsRequest"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Location": {
- "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": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "TransferConfig": {
- "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.",
- "type": "object",
- "properties": {
- "dataSourceId": {
- "description": "Data source id. Cannot be changed once data transfer is created.",
- "type": "string"
- },
- "status": {
- "type": "string",
- "enumDescriptions": [
- "Status placeholder.",
- "Data transfer is inactive.",
- "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
- "Data transfer is in progress.",
- "Data transfer completed successsfully.",
- "Data transfer failed.",
- "Data transfer is cancelled."
- ],
- "enum": [
- "TRANSFER_STATUS_UNSPECIFIED",
- "INACTIVE",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ],
- "description": "Status of the most recently updated transfer run.\n@OutputOnly"
- },
- "destinationDatasetId": {
- "description": "The BigQuery target dataset id.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/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.",
- "type": "string"
- },
- "userId": {
- "format": "int64",
- "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",
- "type": "string"
- },
- "params": {
- "description": "Data transfer specific parameters.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "datasetRegion": {
- "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
- "type": "string"
- },
- "displayName": {
- "description": "User specified display name for the data transfer.",
- "type": "string"
- },
- "disabled": {
- "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
- "type": "boolean"
- },
- "nextRunTime": {
- "format": "google-datetime",
- "description": "Next time when data transfer will run. Output only. Applicable\nonly for batch data transfers.\n@OutputOnly",
- "type": "string"
- },
- "updateTime": {
- "format": "google-datetime",
- "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly",
- "type": "string"
- },
- "schedule": {
- "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
- "type": "string"
- },
- "dataRefreshWindowDays": {
- "format": "int32",
- "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
- "type": "integer"
- }
- },
- "id": "TransferConfig"
- },
- "TransferRun": {
- "description": "Represents a data transfer run.",
- "type": "object",
- "properties": {
- "params": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "Data transfer specific parameters.",
- "type": "object"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time when transfer run ended. Parameter ignored by server for input\nrequests.\n@OutputOnly",
- "type": "string"
- },
- "datasetRegion": {
- "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Time when transfer run was started. Parameter ignored by server for input\nrequests.\n@OutputOnly",
- "type": "string"
- },
- "scheduleTime": {
- "format": "google-datetime",
- "description": "Minimum time after which a transfer run can be started.",
- "type": "string"
- },
- "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"
- },
- "updateTime": {
- "format": "google-datetime",
- "description": "Last time the data transfer run status was updated.\n@OutputOnly",
- "type": "string"
- },
- "runTime": {
- "format": "google-datetime",
- "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
- "type": "string"
- },
- "dataSourceId": {
- "description": "Data source id.\n@OutputOnly",
- "type": "string"
- },
- "status": {
- "description": "Data transfer run status. Ignored for input requests.\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "Status placeholder.",
- "Data transfer is inactive.",
- "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
- "Data transfer is in progress.",
- "Data transfer completed successsfully.",
- "Data transfer failed.",
- "Data transfer is cancelled."
- ],
- "enum": [
- "TRANSFER_STATUS_UNSPECIFIED",
- "INACTIVE",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ]
- },
- "destinationDatasetId": {
- "description": "The BigQuery target dataset id.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
- "type": "string"
- },
- "userId": {
- "format": "int64",
- "description": "The user id for this transfer run.\n@OutputOnly",
- "type": "string"
- }
- },
- "id": "TransferRun"
- },
- "CheckValidCredsRequest": {
- "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
- "type": "object",
- "properties": {},
- "id": "CheckValidCredsRequest"
- },
- "CheckValidCredsResponse": {
- "description": "A response indicating whether the credentials exist and are valid.",
- "type": "object",
- "properties": {
- "hasValidCreds": {
- "description": "If set to `true`, the credentials exist and are valid.",
- "type": "boolean"
- }
- },
- "id": "CheckValidCredsResponse"
- },
- "ScheduleTransferRunsResponse": {
- "description": "A response to schedule transfer runs for a time range.",
- "type": "object",
- "properties": {
- "createdRuns": {
- "description": "The transfer runs that were created.",
- "items": {
- "$ref": "TransferRun"
- },
- "type": "array"
- }
- },
- "id": "ScheduleTransferRunsResponse"
- },
- "TransferMessage": {
- "type": "object",
- "properties": {
- "messageText": {
- "type": "string",
- "description": "Message text."
- },
- "severity": {
- "enum": [
- "MESSAGE_SEVERITY_UNSPECIFIED",
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Message severity.",
- "type": "string",
- "enumDescriptions": [
- "No severity specified.",
- "Informational message.",
- "Warning message.",
- "Error message."
- ]
- },
- "messageTime": {
- "format": "google-datetime",
- "description": "Time when message was logged.",
- "type": "string"
- }
- },
- "id": "TransferMessage",
- "description": "Represents a user facing message for a particular data transfer run."
- },
- "ListTransferLogsResponse": {
- "id": "ListTransferLogsResponse",
- "description": "The returned list transfer run messages.",
- "type": "object",
- "properties": {
- "transferMessages": {
- "description": "The stored pipeline transfer messages.\n@OutputOnly",
- "items": {
- "$ref": "TransferMessage"
- },
- "type": "array"
- },
- "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"
- }
- }
- },
- "ListDataSourcesResponse": {
- "description": "Returns list of supported data sources and their metadata.",
- "type": "object",
- "properties": {
- "dataSources": {
- "description": "List of supported data sources and their transfer settings.",
- "items": {
- "$ref": "DataSource"
- },
- "type": "array"
- },
- "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"
- }
- },
- "id": "ListDataSourcesResponse"
- },
- "DataSourceParameter": {
- "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
- "type": "object",
- "properties": {
- "paramId": {
- "description": "Parameter identifier.",
- "type": "string"
- },
- "required": {
- "description": "Is parameter required.",
- "type": "boolean"
- },
- "repeated": {
- "description": "Can parameter have multiple values.",
- "type": "boolean"
- },
- "displayName": {
- "description": "Parameter display name in the user interface.",
- "type": "string"
- },
- "validationDescription": {
- "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"
- },
- "immutable": {
- "description": "Cannot be changed after initial creation.",
- "type": "boolean"
- },
- "fields": {
- "description": "When parameter is a record, describes child fields.",
- "items": {
- "$ref": "DataSourceParameter"
- },
- "type": "array"
- },
- "maxValue": {
- "format": "double",
- "description": "For integer and double values specifies maxminum allowed value.",
- "type": "number"
- },
- "type": {
- "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."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "STRING",
- "INTEGER",
- "DOUBLE",
- "BOOLEAN",
- "RECORD",
- "PLUS_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"
- },
- "description": {
- "description": "Parameter description.",
- "type": "string"
- },
- "allowedValues": {
- "description": "All possible values for the parameter.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "minValue": {
- "format": "double",
- "description": "For integer and double values specifies minimum allowed value.",
- "type": "number"
- },
- "validationHelpUrl": {
- "description": "URL to a help document to further explain the naming requirements.",
- "type": "string"
- },
- "validationRegex": {
- "description": "Regular expression which can be used for parameter validation.",
- "type": "string"
- }
- },
- "id": "DataSourceParameter"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
- }
- },
- "id": "ListLocationsResponse"
- },
- "ListTransferRunsResponse": {
- "description": "The returned list of pipelines in the project.",
- "type": "object",
- "properties": {
- "transferRuns": {
- "description": "The stored pipeline transfer runs.\n@OutputOnly",
- "items": {
- "$ref": "TransferRun"
- },
- "type": "array"
- },
- "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"
- },
- "IsEnabledRequest": {
- "description": "A request to determine whether data transfer is enabled for the project.",
- "type": "object",
- "properties": {},
- "id": "IsEnabledRequest"
}
},
"icons": {
@@ -1886,14 +1886,14 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/bigquery": {
+ "description": "View and manage your data in Google BigQuery"
+ },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/bigquery": {
- "description": "View and manage your data in Google BigQuery"
}
}
}
diff --git a/books/v1/books-api.json b/books/v1/books-api.json
index 1e26675..1e04302 100644
--- a/books/v1/books-api.json
+++ b/books/v1/books-api.json
@@ -20,7 +20,7 @@
"basePath": "/books/v1/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "books/v1/",
- "batchPath": "batch/books/v1",
+ "batchPath": "batch",
"parameters": {
"alt": {
"type": "string",
diff --git a/classroom/v1/classroom-api.json b/classroom/v1/classroom-api.json
index 34e293a..a8f801e 100644
--- a/classroom/v1/classroom-api.json
+++ b/classroom/v1/classroom-api.json
@@ -1,1569 +1,42 @@
{
- "resources": {
- "invitations": {
- "methods": {
- "list": {
- "id": "classroom.invitations.list",
- "path": "v1/invitations",
- "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
- "response": {
- "$ref": "ListInvitationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "userId": {
- "type": "string",
- "location": "query",
- "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results."
- },
- "courseId": {
- "type": "string",
- "location": "query",
- "description": "Restricts returned invitations to those for a course with the specified\nidentifier."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/invitations"
- },
- "get": {
- "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "response": {
- "$ref": "Invitation"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the invitation to return.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/invitations/{id}",
- "id": "classroom.invitations.get",
- "path": "v1/invitations/{id}"
- },
- "create": {
- "response": {
- "$ref": "Invitation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/invitations",
- "id": "classroom.invitations.create",
- "path": "v1/invitations",
- "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
- "request": {
- "$ref": "Invitation"
- }
- },
- "accept": {
- "flatPath": "v1/invitations/{id}:accept",
- "path": "v1/invitations/{id}:accept",
- "id": "classroom.invitations.accept",
- "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "httpMethod": "POST",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Identifier of the invitation to accept.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ]
- },
- "delete": {
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the invitation to delete.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/invitations/{id}"
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "response": {
- "$ref": "UserProfile"
- },
- "parameterOrder": [
- "userId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/userProfiles/{userId}",
- "id": "classroom.userProfiles.get",
- "path": "v1/userProfiles/{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."
- }
- },
- "resources": {
- "guardianInvitations": {
- "methods": {
- "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"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "studentId",
- "invitationId"
- ],
- "response": {
- "$ref": "GuardianInvitation"
- },
- "parameters": {
- "updateMask": {
- "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,...`",
- "type": "string",
- "location": "query"
- },
- "invitationId": {
- "location": "path",
- "description": "The `id` field of the `GuardianInvitation` to be modified.",
- "type": "string",
- "required": true
- },
- "studentId": {
- "description": "The ID of the student whose guardian invitation is to be modified.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "id": "classroom.userProfiles.guardianInvitations.patch"
- },
- "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"
- },
- "parameterOrder": [
- "studentId",
- "invitationId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "invitationId": {
- "location": "path",
- "description": "The `id` field of the `GuardianInvitation` being requested.",
- "type": "string",
- "required": true
- },
- "studentId": {
- "description": "The ID of the student whose guardian invitation is being requested.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students",
- "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "id": "classroom.userProfiles.guardianInvitations.get",
- "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
- },
- "list": {
- "response": {
- "$ref": "ListGuardianInvitationsResponse"
- },
- "parameterOrder": [
- "studentId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "studentId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations."
- },
- "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": {
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer",
- "location": "query"
- },
- "states": {
- "location": "query",
- "enum": [
- "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
- "PENDING",
- "COMPLETE"
- ],
- "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
- },
- "invitedEmailAddress": {
- "location": "query",
- "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
- "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",
- "id": "classroom.userProfiles.guardianInvitations.list",
- "path": "v1/userProfiles/{studentId}/guardianInvitations",
- "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student."
- },
- "create": {
- "id": "classroom.userProfiles.guardianInvitations.create",
- "path": "v1/userProfiles/{studentId}/guardianInvitations",
- "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"
- },
- "response": {
- "$ref": "GuardianInvitation"
- },
- "parameterOrder": [
- "studentId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "studentId": {
- "location": "path",
- "description": "ID of the student (in standard format)",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations"
- }
- }
- },
- "guardians": {
- "methods": {
- "get": {
- "parameterOrder": [
- "studentId",
- "guardianId"
- ],
- "response": {
- "$ref": "Guardian"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
- "https://www.googleapis.com/auth/classroom.guardianlinks.students",
- "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
- ],
- "parameters": {
- "studentId": {
- "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "guardianId": {
- "location": "path",
- "description": "The `id` field from a `Guardian`.",
- "type": "string",
- "required": true
- }
- },
- "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`."
- },
- "list": {
- "flatPath": "v1/userProfiles/{studentId}/guardians",
- "path": "v1/userProfiles/{studentId}/guardians",
- "id": "classroom.userProfiles.guardians.list",
- "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
- "httpMethod": "GET",
- "parameterOrder": [
- "studentId"
- ],
- "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": {
- "studentId": {
- "location": "path",
- "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer",
- "location": "query"
- },
- "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"
- }
- }
- },
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "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",
- "type": "string",
- "required": true
- },
- "guardianId": {
- "location": "path",
- "description": "The `id` field from a `Guardian`.",
- "type": "string",
- "required": true
- }
- },
- "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`.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "studentId",
- "guardianId"
- ]
- }
- }
- }
- }
- },
- "courses": {
- "methods": {
- "get": {
- "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "flatPath": "v1/courses/{id}",
- "id": "classroom.courses.get",
- "path": "v1/courses/{id}"
- },
- "patch": {
- "request": {
- "$ref": "Course"
- },
- "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "id": {
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/courses/{id}",
- "id": "classroom.courses.patch",
- "path": "v1/courses/{id}"
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Course"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "id": {
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.update",
- "request": {
- "$ref": "Course"
- },
- "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable"
- },
- "delete": {
- "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.delete"
- },
- "list": {
- "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.",
- "response": {
- "$ref": "ListCoursesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "parameters": {
- "studentId": {
- "type": "string",
- "location": "query",
- "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer",
- "location": "query"
- },
- "courseStates": {
- "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "COURSE_STATE_UNSPECIFIED",
- "ACTIVE",
- "ARCHIVED",
- "PROVISIONED",
- "DECLINED",
- "SUSPENDED"
- ]
- },
- "teacherId": {
- "location": "query",
- "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
- }
- },
- "flatPath": "v1/courses",
- "id": "classroom.courses.list",
- "path": "v1/courses"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Course"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {},
- "flatPath": "v1/courses",
- "path": "v1/courses",
- "id": "classroom.courses.create",
- "request": {
- "$ref": "Course"
- },
- "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists."
- }
- },
- "resources": {
- "aliases": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "courseId",
- "alias"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "courseId": {
- "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "alias": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier."
- }
- },
- "flatPath": "v1/courses/{courseId}/aliases/{alias}",
- "path": "v1/courses/{courseId}/aliases/{alias}",
- "id": "classroom.courses.aliases.delete",
- "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias)."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListCourseAliasesResponse"
- },
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer",
- "location": "query"
- },
- "courseId": {
- "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.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": {
- "response": {
- "$ref": "CourseAlias"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "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": {
- "delete": {
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "id": "classroom.courses.students.delete",
- "path": "v1/courses/{courseId}/students/{userId}",
- "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- }
- }
- },
- "list": {
- "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
- "response": {
- "$ref": "ListStudentsResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results."
- }
- },
- "flatPath": "v1/courses/{courseId}/students",
- "id": "classroom.courses.students.list",
- "path": "v1/courses/{courseId}/students"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "response": {
- "$ref": "Student"
- },
- "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",
- "type": "string",
- "required": true
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "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."
- },
- "create": {
- "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.",
- "request": {
- "$ref": "Student"
- },
- "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": {
- "location": "path",
- "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- }
- },
- "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",
- "id": "classroom.courses.students.create",
- "path": "v1/courses/{courseId}/students"
- }
- }
- },
- "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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "id": {
- "location": "path",
- "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.delete"
- },
- "list": {
- "response": {
- "$ref": "ListCourseWorkResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "courseWorkStates": {
- "location": "query",
- "enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.",
- "type": "string",
- "repeated": true
- },
- "courseId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.list",
- "path": "v1/courses/{courseId}/courseWork",
- "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
- ],
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "id": {
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.get",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "GET"
- },
- "patch": {
- "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "CourseWork"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "response": {
- "$ref": "CourseWork"
- },
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "id": {
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.patch"
- },
- "create": {
- "request": {
- "$ref": "CourseWork"
- },
- "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "CourseWork"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork",
- "path": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.create"
- }
- },
- "resources": {
- "studentSubmissions": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListStudentSubmissionsResponse"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
- "type": "string",
- "required": true
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "late": {
- "location": "query",
- "enum": [
- "LATE_VALUES_UNSPECIFIED",
- "LATE_ONLY",
- "NOT_LATE_ONLY"
- ],
- "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "states": {
- "repeated": true,
- "location": "query",
- "enum": [
- "SUBMISSION_STATE_UNSPECIFIED",
- "NEW",
- "CREATED",
- "TURNED_IN",
- "RETURNED",
- "RECLAIMED_BY_STUDENT"
- ],
- "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer"
- },
- "userId": {
- "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly",
- "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
- "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "id": "classroom.courses.courseWork.studentSubmissions.list",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
- },
- "modifyAttachments": {
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameters": {
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
- "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
- "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "ModifyAttachmentsRequest"
- }
- },
- "patch": {
- "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.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "id": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifier of the student submission."
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`",
- "type": "string",
- "location": "query"
- },
- "courseWorkId": {
- "type": "string",
- "required": true,
- "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"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "id": "classroom.courses.courseWork.studentSubmissions.patch",
- "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "StudentSubmission"
- }
- },
- "get": {
- "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "httpMethod": "GET",
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "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": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "courseWorkId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifier of the course work."
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "id": "classroom.courses.courseWork.studentSubmissions.get"
- },
- "return": {
- "id": "classroom.courses.courseWork.studentSubmissions.return",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
- "request": {
- "$ref": "ReturnStudentSubmissionRequest"
- },
- "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true
- },
- "courseId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- },
- "id": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifier of the student submission."
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return"
- },
- "reclaim": {
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "id": {
- "description": "Identifier of the student submission.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
- "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
- "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "ReclaimStudentSubmissionRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST"
- },
- "turnIn": {
- "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "request": {
- "$ref": "TurnInStudentSubmissionRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST",
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn"
- }
- }
- }
- }
- },
- "teachers": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "userId": {
- "location": "path",
- "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.delete",
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course."
- },
- "list": {
- "response": {
- "$ref": "ListTeachersResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "type": "string",
- "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."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer"
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.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",
- "id": "classroom.courses.teachers.list",
- "path": "v1/courses/{courseId}/teachers",
- "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors."
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.get",
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
- "response": {
- "$ref": "Teacher"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "GET"
- },
- "create": {
- "id": "classroom.courses.teachers.create",
- "path": "v1/courses/{courseId}/teachers",
- "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
- "request": {
- "$ref": "Teacher"
- },
- "response": {
- "$ref": "Teacher"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/courses/{courseId}/teachers"
- }
- }
- }
- }
- }
- },
"parameters": {
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "boolean"
},
"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": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
},
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
"fields": {
"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",
@@ -1577,6 +50,11 @@
],
"location": "query"
},
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"alt": {
"description": "Data format for response.",
"default": "json",
@@ -1593,213 +71,77 @@
],
"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": {
- "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"
}
},
"schemas": {
- "ListTeachersResponse": {
- "description": "Response when listing teachers.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "teachers": {
- "description": "Teachers who match the list request.",
- "items": {
- "$ref": "Teacher"
- },
- "type": "array"
- }
- },
- "id": "ListTeachersResponse"
- },
- "Link": {
- "description": "URL item.",
- "type": "object",
- "properties": {
- "thumbnailUrl": {
- "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
- "type": "string"
- },
- "url": {
- "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
- "type": "string"
- },
- "title": {
- "type": "string",
- "description": "Title of the target of the URL.\n\nRead-only."
- }
- },
- "id": "Link"
- },
- "ListGuardiansResponse": {
- "id": "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.",
- "items": {
- "$ref": "Guardian"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- }
- }
- },
- "CourseAlias": {
- "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.",
- "type": "object"
- },
- "ListCourseAliasesResponse": {
- "properties": {
- "aliases": {
- "description": "The course aliases.",
- "items": {
- "$ref": "CourseAlias"
- },
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
- }
- },
- "id": "ListCourseAliasesResponse",
- "description": "Response when listing course aliases.",
- "type": "object"
- },
- "ListGuardianInvitationsResponse": {
- "description": "Response when listing guardian invitations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
- },
- "guardianInvitations": {
- "description": "Guardian invitations that matched the list request.",
- "items": {
- "$ref": "GuardianInvitation"
- },
- "type": "array"
- }
- },
- "id": "ListGuardianInvitationsResponse"
- },
- "Date": {
- "type": "object",
- "properties": {
- "day": {
- "type": "integer",
- "format": "int32",
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant."
- },
- "year": {
- "format": "int32",
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "type": "integer"
- },
- "month": {
- "type": "integer",
- "format": "int32",
- "description": "Month of year. Must be from 1 to 12."
- }
- },
- "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`."
- },
- "MultipleChoiceSubmission": {
- "description": "Student work for a multiple-choice question.",
- "type": "object",
- "properties": {
- "answer": {
- "description": "Student's select choice.",
- "type": "string"
- }
- },
- "id": "MultipleChoiceSubmission"
- },
"CourseMaterial": {
"description": "A material attached to a course as part of a material set.",
"type": "object",
"properties": {
+ "link": {
+ "$ref": "Link",
+ "description": "Link atatchment."
+ },
"youTubeVideo": {
"$ref": "YouTubeVideo",
"description": "Youtube video attachment."
},
"driveFile": {
- "description": "Google Drive file attachment.",
- "$ref": "DriveFile"
+ "$ref": "DriveFile",
+ "description": "Google Drive file attachment."
},
"form": {
"description": "Google Forms attachment.",
"$ref": "Form"
- },
- "link": {
- "description": "Link atatchment.",
- "$ref": "Link"
}
},
"id": "CourseMaterial"
},
"Name": {
- "description": "Details of the user's name.",
"type": "object",
"properties": {
+ "fullName": {
+ "type": "string",
+ "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only."
+ },
"familyName": {
"description": "The user's last name.\n\nRead-only.",
"type": "string"
},
"givenName": {
- "description": "The user's first name.\n\nRead-only.",
- "type": "string"
- },
- "fullName": {
- "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",
- "type": "string"
+ "type": "string",
+ "description": "The user's first name.\n\nRead-only."
}
},
- "id": "Name"
+ "id": "Name",
+ "description": "Details of the user's name."
},
"Assignment": {
- "description": "Additional details for assignments.",
- "type": "object",
"properties": {
"studentWorkFolder": {
- "$ref": "DriveFolder",
- "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers and administrators."
+ "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers and administrators.",
+ "$ref": "DriveFolder"
}
},
- "id": "Assignment"
+ "id": "Assignment",
+ "description": "Additional details for assignments.",
+ "type": "object"
},
"SharedDriveFile": {
- "description": "Drive file that is used as material for course work.",
"type": "object",
"properties": {
"shareMode": {
@@ -1823,17 +165,16 @@
"description": "Drive file details."
}
},
- "id": "SharedDriveFile"
+ "id": "SharedDriveFile",
+ "description": "Drive file that is used as material for course work."
},
"Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ "id": "Empty"
},
"MultipleChoiceQuestion": {
- "description": "Additional details for multiple-choice questions.",
- "type": "object",
"properties": {
"choices": {
"description": "Possible choices.",
@@ -1843,11 +184,19 @@
"type": "array"
}
},
- "id": "MultipleChoiceQuestion"
+ "id": "MultipleChoiceQuestion",
+ "description": "Additional details for multiple-choice questions.",
+ "type": "object"
},
"Course": {
+ "id": "Course",
+ "description": "A Course in Classroom.",
"type": "object",
"properties": {
+ "enrollmentCode": {
+ "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "type": "string"
+ },
"courseMaterialSets": {
"description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
"items": {
@@ -1855,35 +204,27 @@
},
"type": "array"
},
- "enrollmentCode": {
- "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "type": "string"
- },
"descriptionHeading": {
"description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
"type": "string"
},
+ "calendarId": {
+ "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
+ "type": "string"
+ },
"updateTime": {
"format": "google-datetime",
"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"
},
- "calendarId": {
- "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
- "type": "string"
- },
"alternateLink": {
- "type": "string",
- "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only."
+ "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
+ "type": "string"
},
"guardiansEnabled": {
"description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
"type": "boolean"
},
- "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. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only."
- },
"courseState": {
"enumDescriptions": [
"No course state. No returned Course message will use this value.",
@@ -1904,13 +245,17 @@
"description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
"type": "string"
},
+ "ownerId": {
+ "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.",
+ "type": "string"
+ },
"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"
+ "type": "string",
+ "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."
},
"creationTime": {
"format": "google-datetime",
@@ -1941,22 +286,12 @@
"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"
}
- },
- "id": "Course",
- "description": "A Course in Classroom."
+ }
},
"DriveFile": {
"description": "Representation of a Google Drive file.",
"type": "object",
"properties": {
- "title": {
- "description": "Title of the Drive item.\n\nRead-only.",
- "type": "string"
- },
- "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"
@@ -1964,6 +299,14 @@
"id": {
"description": "Drive API resource ID.",
"type": "string"
+ },
+ "title": {
+ "description": "Title of the Drive item.\n\nRead-only.",
+ "type": "string"
+ },
+ "alternateLink": {
+ "description": "URL that can be used to access the Drive item.\n\nRead-only.",
+ "type": "string"
}
},
"id": "DriveFile"
@@ -1975,8 +318,6 @@
"id": "ReturnStudentSubmissionRequest"
},
"GlobalPermission": {
- "description": "Global user permission description.",
- "type": "object",
"properties": {
"permission": {
"enum": [
@@ -1991,16 +332,12 @@
]
}
},
- "id": "GlobalPermission"
+ "id": "GlobalPermission",
+ "description": "Global user permission description.",
+ "type": "object"
},
"Teacher": {
- "description": "Teacher of a course.",
- "type": "object",
"properties": {
- "profile": {
- "$ref": "UserProfile",
- "description": "Global user information for the teacher.\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"
@@ -2008,26 +345,36 @@
"courseId": {
"description": "Identifier of the course.\n\nRead-only.",
"type": "string"
+ },
+ "profile": {
+ "$ref": "UserProfile",
+ "description": "Global user information for the teacher.\n\nRead-only."
}
},
- "id": "Teacher"
+ "id": "Teacher",
+ "description": "Teacher of a course.",
+ "type": "object"
},
"ReclaimStudentSubmissionRequest": {
- "description": "Request to reclaim a student submission.",
- "type": "object",
"properties": {},
- "id": "ReclaimStudentSubmissionRequest"
+ "id": "ReclaimStudentSubmissionRequest",
+ "description": "Request to reclaim a student submission.",
+ "type": "object"
},
"GradeHistory": {
"description": "The history of each grade on this submission.",
"type": "object",
"properties": {
+ "pointsEarned": {
+ "format": "double",
+ "description": "The numerator of the grade at this time in the submission grade history.",
+ "type": "number"
+ },
"actorUserId": {
"description": "The teacher who made the grade change.",
"type": "string"
},
"gradeChangeType": {
- "description": "The type of grade change at this time in the submission grade history.",
"type": "string",
"enumDescriptions": [
"No grade change type specified. This should never be returned.",
@@ -2040,7 +387,8 @@
"DRAFT_GRADE_POINTS_EARNED_CHANGE",
"ASSIGNED_GRADE_POINTS_EARNED_CHANGE",
"MAX_POINTS_CHANGE"
- ]
+ ],
+ "description": "The type of grade change at this time in the submission grade history."
},
"gradeTimestamp": {
"format": "google-datetime",
@@ -2051,11 +399,6 @@
"format": "double",
"description": "The denominator of the grade at this time in the submission grade\nhistory.",
"type": "number"
- },
- "pointsEarned": {
- "format": "double",
- "description": "The numerator of the grade at this time in the submission grade history.",
- "type": "number"
}
},
"id": "GradeHistory"
@@ -2075,7 +418,18 @@
"id": "AssignmentSubmission"
},
"Material": {
+ "id": "Material",
+ "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
+ "type": "object",
"properties": {
+ "youtubeVideo": {
+ "description": "YouTube video material.",
+ "$ref": "YouTubeVideo"
+ },
+ "driveFile": {
+ "description": "Google Drive file material.",
+ "$ref": "SharedDriveFile"
+ },
"form": {
"description": "Google Forms material.",
"$ref": "Form"
@@ -2083,117 +437,13 @@
"link": {
"$ref": "Link",
"description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response."
- },
- "youtubeVideo": {
- "description": "YouTube video material.",
- "$ref": "YouTubeVideo"
- },
- "driveFile": {
- "$ref": "SharedDriveFile",
- "description": "Google Drive file material."
}
- },
- "id": "Material",
- "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
- "type": "object"
+ }
},
"CourseWork": {
- "id": "CourseWork",
"description": "Course work created by a teacher for students of the course.",
"type": "object",
"properties": {
- "assignment": {
- "$ref": "Assignment",
- "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
- },
- "multipleChoiceQuestion": {
- "$ref": "MultipleChoiceQuestion",
- "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise."
- },
- "workType": {
- "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
- "type": "string",
- "enumDescriptions": [
- "No work type specified. This is never returned.",
- "An assignment.",
- "A short answer question.",
- "A multiple-choice question."
- ],
- "enum": [
- "COURSE_WORK_TYPE_UNSPECIFIED",
- "ASSIGNMENT",
- "SHORT_ANSWER_QUESTION",
- "MULTIPLE_CHOICE_QUESTION"
- ]
- },
- "scheduledTime": {
- "format": "google-datetime",
- "description": "Optional timestamp when this course work is scheduled to be published.",
- "type": "string"
- },
- "description": {
- "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
- "type": "string"
- },
- "creationTime": {
- "format": "google-datetime",
- "description": "Timestamp when this course work was created.\n\nRead-only.",
- "type": "string"
- },
- "dueDate": {
- "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified.",
- "$ref": "Date"
- },
- "submissionModificationMode": {
- "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"
- },
- "state": {
- "enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "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."
- ]
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only."
- },
- "dueTime": {
- "$ref": "TimeOfDay",
- "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified."
- },
- "title": {
- "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
- "type": "string"
- },
- "associatedWithDeveloper": {
- "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
- "type": "boolean"
- },
"materials": {
"description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
"items": {
@@ -2201,6 +451,10 @@
},
"type": "array"
},
+ "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"
+ },
"updateTime": {
"format": "google-datetime",
"description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
@@ -2214,8 +468,97 @@
"format": "double",
"description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
"type": "number"
+ },
+ "workType": {
+ "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",
+ "enumDescriptions": [
+ "No work type specified. This is never returned.",
+ "An assignment.",
+ "A short answer question.",
+ "A multiple-choice question."
+ ]
+ },
+ "assignment": {
+ "$ref": "Assignment",
+ "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
+ },
+ "multipleChoiceQuestion": {
+ "$ref": "MultipleChoiceQuestion",
+ "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise."
+ },
+ "description": {
+ "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
+ "type": "string"
+ },
+ "scheduledTime": {
+ "format": "google-datetime",
+ "description": "Optional timestamp when this course work is scheduled to be published.",
+ "type": "string"
+ },
+ "creationTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "Timestamp when this course work was created.\n\nRead-only."
+ },
+ "dueDate": {
+ "$ref": "Date",
+ "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified."
+ },
+ "submissionModificationMode": {
+ "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",
+ "enumDescriptions": [
+ "No modification mode specified. This is never returned.",
+ "Submisisons can be modified before being turned in.",
+ "Submisisons can be modified at any time."
+ ]
+ },
+ "state": {
+ "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"
+ ],
+ "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`."
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
+ "type": "string"
+ },
+ "dueTime": {
+ "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified.",
+ "$ref": "TimeOfDay"
+ },
+ "title": {
+ "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
+ "type": "string"
}
- }
+ },
+ "id": "CourseWork"
},
"Guardian": {
"description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.",
@@ -2234,13 +577,32 @@
"type": "string"
},
"guardianProfile": {
- "description": "User profile for the guardian.",
- "$ref": "UserProfile"
+ "$ref": "UserProfile",
+ "description": "User profile for the guardian."
}
},
"id": "Guardian"
},
+ "ListStudentsResponse": {
+ "id": "ListStudentsResponse",
+ "description": "Response when listing students.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "students": {
+ "description": "Students who match the list request.",
+ "items": {
+ "$ref": "Student"
+ },
+ "type": "array"
+ }
+ }
+ },
"UserProfile": {
+ "id": "UserProfile",
"description": "Global information for a user.",
"type": "object",
"properties": {
@@ -2260,46 +622,22 @@
"type": "array"
},
"name": {
- "$ref": "Name",
- "description": "Name of the user.\n\nRead-only."
+ "description": "Name of the user.\n\nRead-only.",
+ "$ref": "Name"
},
"id": {
- "type": "string",
- "description": "Identifier of the user.\n\nRead-only."
+ "description": "Identifier of the user.\n\nRead-only.",
+ "type": "string"
},
"verifiedTeacher": {
"description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
"type": "boolean"
}
- },
- "id": "UserProfile"
- },
- "ListStudentsResponse": {
- "description": "Response when listing students.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "students": {
- "description": "Students who match the list request.",
- "items": {
- "$ref": "Student"
- },
- "type": "array"
- }
- },
- "id": "ListStudentsResponse"
+ }
},
"Student": {
- "description": "Student in a course.",
"type": "object",
"properties": {
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
"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."
@@ -2311,23 +649,34 @@
"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"
+ "id": "Student",
+ "description": "Student in a course."
},
"Invitation": {
"description": "An invitation to join a course.",
"type": "object",
"properties": {
- "courseId": {
- "description": "Identifier of the course to invite the user to.",
+ "userId": {
+ "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"type": "string"
},
+ "courseId": {
+ "type": "string",
+ "description": "Identifier of the course to invite the user to."
+ },
"id": {
"description": "Identifier assigned by Classroom.\n\nRead-only.",
"type": "string"
},
"role": {
+ "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
+ "type": "string",
"enumDescriptions": [
"No course role.",
"Student in the course.",
@@ -2339,13 +688,7 @@
"STUDENT",
"TEACHER",
"OWNER"
- ],
- "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
- "type": "string"
- },
- "userId": {
- "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
+ ]
}
},
"id": "Invitation"
@@ -2354,6 +697,10 @@
"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"
@@ -2361,41 +708,38 @@
"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"
},
"SubmissionHistory": {
+ "description": "The history of the submission. This currently includes state and grade\nhistories.",
"type": "object",
"properties": {
+ "gradeHistory": {
+ "$ref": "GradeHistory",
+ "description": "The grade history information of the submission, if present."
+ },
"stateHistory": {
"description": "The state history information of the submission, if present.",
"$ref": "StateHistory"
- },
- "gradeHistory": {
- "description": "The grade history information of the submission, if present.",
- "$ref": "GradeHistory"
}
},
- "id": "SubmissionHistory",
- "description": "The history of the submission. This currently includes state and grade\nhistories."
+ "id": "SubmissionHistory"
},
"ShortAnswerSubmission": {
+ "description": "Student work for a short answer question.",
"type": "object",
"properties": {
"answer": {
- "type": "string",
- "description": "Student response to a short-answer question."
+ "description": "Student response to a short-answer question.",
+ "type": "string"
}
},
- "id": "ShortAnswerSubmission",
- "description": "Student work for a short answer question."
+ "id": "ShortAnswerSubmission"
},
"StudentSubmission": {
+ "id": "StudentSubmission",
"description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
"type": "object",
"properties": {
@@ -2405,7 +749,6 @@
"type": "string"
},
"state": {
- "description": "State of this submission.\n\nRead-only.",
"type": "string",
"enumDescriptions": [
"No state specified. This should never be returned.",
@@ -2422,7 +765,8 @@
"TURNED_IN",
"RETURNED",
"RECLAIMED_BY_STUDENT"
- ]
+ ],
+ "description": "State of this submission.\n\nRead-only."
},
"userId": {
"description": "Identifier for the student that owns this submission.\n\nRead-only.",
@@ -2448,9 +792,9 @@
"type": "array"
},
"assignedGrade": {
+ "type": "number",
"format": "double",
- "description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis may be modified only by course teachers.",
- "type": "number"
+ "description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis may be modified only by course teachers."
},
"multipleChoiceSubmission": {
"$ref": "MultipleChoiceSubmission",
@@ -2474,25 +818,19 @@
"type": "string"
},
"alternateLink": {
- "type": "string",
- "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only."
+ "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
+ "type": "string"
+ },
+ "late": {
+ "description": "Whether this submission is late.\n\nRead-only.",
+ "type": "boolean"
},
"draftGrade": {
"format": "double",
"description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.",
"type": "number"
},
- "late": {
- "description": "Whether this submission is late.\n\nRead-only.",
- "type": "boolean"
- },
"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",
@@ -2500,12 +838,25 @@
"MULTIPLE_CHOICE_QUESTION"
],
"description": "Type of course work this submission is for.\n\nRead-only.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "No work type specified. This is never returned.",
+ "An assignment.",
+ "A short answer question.",
+ "A multiple-choice question."
+ ]
}
- },
- "id": "StudentSubmission"
+ }
+ },
+ "TurnInStudentSubmissionRequest": {
+ "description": "Request to turn in a student submission.",
+ "type": "object",
+ "properties": {},
+ "id": "TurnInStudentSubmissionRequest"
},
"ListStudentSubmissionsResponse": {
+ "id": "ListStudentSubmissionsResponse",
+ "description": "Response when listing student submissions.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -2519,15 +870,25 @@
},
"type": "array"
}
- },
- "id": "ListStudentSubmissionsResponse",
- "description": "Response when listing student submissions."
+ }
},
- "TurnInStudentSubmissionRequest": {
- "id": "TurnInStudentSubmissionRequest",
- "description": "Request to turn in a student submission.",
+ "ListCourseWorkResponse": {
+ "description": "Response when listing course work.",
"type": "object",
- "properties": {}
+ "properties": {
+ "courseWork": {
+ "description": "Course work items that match the request.",
+ "items": {
+ "$ref": "CourseWork"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "id": "ListCourseWorkResponse"
},
"ModifyAttachmentsRequest": {
"description": "Request to modify the attachments of a student submission.",
@@ -2543,31 +904,14 @@
},
"id": "ModifyAttachmentsRequest"
},
- "ListCourseWorkResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "courseWork": {
- "description": "Course work items that match the request.",
- "items": {
- "$ref": "CourseWork"
- },
- "type": "array"
- }
- },
- "id": "ListCourseWorkResponse",
- "description": "Response when listing course work."
- },
"YouTubeVideo": {
+ "id": "YouTubeVideo",
"description": "YouTube video item.",
"type": "object",
"properties": {
"id": {
- "description": "YouTube API resource ID.",
- "type": "string"
+ "type": "string",
+ "description": "YouTube API resource ID."
},
"title": {
"description": "Title of the YouTube video.\n\nRead-only.",
@@ -2581,11 +925,9 @@
"description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
"type": "string"
}
- },
- "id": "YouTubeVideo"
+ }
},
"ListInvitationsResponse": {
- "id": "ListInvitationsResponse",
"description": "Response when listing invitations.",
"type": "object",
"properties": {
@@ -2600,10 +942,10 @@
},
"type": "array"
}
- }
+ },
+ "id": "ListInvitationsResponse"
},
"Attachment": {
- "id": "Attachment",
"description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
"type": "object",
"properties": {
@@ -2612,8 +954,8 @@
"$ref": "YouTubeVideo"
},
"driveFile": {
- "$ref": "DriveFile",
- "description": "Google Drive file attachment."
+ "description": "Google Drive file attachment.",
+ "$ref": "DriveFile"
},
"form": {
"$ref": "Form",
@@ -2623,16 +965,22 @@
"description": "Link attachment.",
"$ref": "Link"
}
- }
+ },
+ "id": "Attachment"
},
"GuardianInvitation": {
- "type": "object",
"properties": {
+ "creationTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "The time that this invitation was created.\n\nRead-only."
+ },
"invitationId": {
- "description": "Unique identifier for this invitation.\n\nRead-only.",
- "type": "string"
+ "type": "string",
+ "description": "Unique identifier for this invitation.\n\nRead-only."
},
"state": {
+ "description": "The state that this invitation is in.",
"type": "string",
"enumDescriptions": [
"Should never be returned.",
@@ -2643,40 +991,27 @@
"GUARDIAN_INVITATION_STATE_UNSPECIFIED",
"PENDING",
"COMPLETE"
- ],
- "description": "The state that this invitation is in."
+ ]
},
"studentId": {
- "type": "string",
- "description": "ID of the student (in standard format)"
+ "description": "ID of the student (in standard format)",
+ "type": "string"
},
"invitedEmailAddress": {
"description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
"type": "string"
- },
- "creationTime": {
- "format": "google-datetime",
- "description": "The time that this invitation was created.\n\nRead-only.",
- "type": "string"
}
},
"id": "GuardianInvitation",
- "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address."
+ "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
+ "type": "object"
},
"StateHistory": {
"description": "The history of each state this submission has been in.",
"type": "object",
"properties": {
- "stateTimestamp": {
- "format": "google-datetime",
- "description": "When the submission entered this state.",
- "type": "string"
- },
- "actorUserId": {
- "description": "The teacher or student who made the change",
- "type": "string"
- },
"state": {
+ "type": "string",
"enumDescriptions": [
"No state specified. This should never be returned.",
"The Submission has been created.",
@@ -2693,14 +1028,21 @@
"RECLAIMED_BY_STUDENT",
"STUDENT_EDITED_AFTER_TURN_IN"
],
- "description": "The workflow pipeline stage.",
+ "description": "The workflow pipeline stage."
+ },
+ "stateTimestamp": {
+ "format": "google-datetime",
+ "description": "When the submission entered this state.",
+ "type": "string"
+ },
+ "actorUserId": {
+ "description": "The teacher or student who made the change",
"type": "string"
}
},
"id": "StateHistory"
},
"CourseMaterialSet": {
- "id": "CourseMaterialSet",
"description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
"type": "object",
"properties": {
@@ -2715,7 +1057,8 @@
"description": "Title for this set.",
"type": "string"
}
- }
+ },
+ "id": "CourseMaterialSet"
},
"TimeOfDay": {
"type": "object",
@@ -2749,59 +1092,188 @@
"type": "object",
"properties": {
"nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
+ "type": "string",
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
},
"courses": {
+ "description": "Courses that match the list request.",
"items": {
"$ref": "Course"
},
- "type": "array",
- "description": "Courses that match the list request."
+ "type": "array"
}
},
"id": "ListCoursesResponse"
},
"Form": {
- "description": "Google Forms item.",
- "type": "object",
"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"
+ "type": "string",
+ "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."
},
"formUrl": {
- "type": "string",
- "description": "URL of the form."
+ "description": "URL of the form.",
+ "type": "string"
},
"title": {
"description": "Title of the Form.\n\nRead-only.",
"type": "string"
}
},
- "id": "Form"
+ "id": "Form",
+ "description": "Google Forms item.",
+ "type": "object"
+ },
+ "ListTeachersResponse": {
+ "description": "Response when listing teachers.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "teachers": {
+ "description": "Teachers who match the list request.",
+ "items": {
+ "$ref": "Teacher"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListTeachersResponse"
+ },
+ "Link": {
+ "description": "URL item.",
+ "type": "object",
+ "properties": {
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Title of the target of the URL.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "id": "Link"
+ },
+ "ListGuardiansResponse": {
+ "description": "Response when listing guardians.",
+ "type": "object",
+ "properties": {
+ "guardians": {
+ "items": {
+ "$ref": "Guardian"
+ },
+ "type": "array",
+ "description": "Guardians on this page of results that met the criteria specified in\nthe request."
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "id": "ListGuardiansResponse"
+ },
+ "CourseAlias": {
+ "type": "object",
+ "properties": {
+ "alias": {
+ "type": "string",
+ "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."
+ }
+ },
+ "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."
+ },
+ "ListGuardianInvitationsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "guardianInvitations": {
+ "description": "Guardian invitations that matched the list request.",
+ "items": {
+ "$ref": "GuardianInvitation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListGuardianInvitationsResponse",
+ "description": "Response when listing guardian invitations.",
+ "type": "object"
+ },
+ "ListCourseAliasesResponse": {
+ "description": "Response when listing course aliases.",
+ "type": "object",
+ "properties": {
+ "aliases": {
+ "description": "The course aliases.",
+ "items": {
+ "$ref": "CourseAlias"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "id": "ListCourseAliasesResponse"
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object",
+ "properties": {
+ "day": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant."
+ },
+ "year": {
+ "format": "int32",
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "type": "integer"
+ },
+ "month": {
+ "format": "int32",
+ "description": "Month of year. Must be from 1 to 12.",
+ "type": "integer"
+ }
+ },
+ "id": "Date"
+ },
+ "MultipleChoiceSubmission": {
+ "properties": {
+ "answer": {
+ "description": "Student's select choice.",
+ "type": "string"
+ }
+ },
+ "id": "MultipleChoiceSubmission",
+ "description": "Student work for a multiple-choice question.",
+ "type": "object"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
"version": "v1",
"baseUrl": "https://classroom.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/classroom.rosters.readonly": {
- "description": "View your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.profile.photos": {
- "description": "View the profile photos of people in your classes"
- },
"https://www.googleapis.com/auth/classroom.guardianlinks.students": {
"description": "View and manage guardians for students in your Google Classroom classes"
},
@@ -2840,22 +1312,1550 @@
},
"https://www.googleapis.com/auth/classroom.courses.readonly": {
"description": "View your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.rosters.readonly": {
+ "description": "View your Google Classroom class rosters"
+ },
+ "https://www.googleapis.com/auth/classroom.profile.photos": {
+ "description": "View the profile photos of people in your classes"
}
}
}
},
- "servicePath": "",
- "description": "Manages classes, rosters, and invitations in Google Classroom.",
"kind": "discovery#restDescription",
+ "description": "Manages classes, rosters, and invitations in Google Classroom.",
+ "servicePath": "",
"rootUrl": "https://classroom.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "classroom",
"batchPath": "batch",
- "id": "classroom:v1",
"documentationLink": "https://developers.google.com/classroom/",
- "revision": "20170823",
+ "id": "classroom:v1",
+ "revision": "20170824",
"title": "Google Classroom API",
+ "ownerName": "Google",
"discoveryVersion": "v1",
- "ownerName": "Google"
+ "resources": {
+ "invitations": {
+ "methods": {
+ "create": {
+ "flatPath": "v1/invitations",
+ "id": "classroom.invitations.create",
+ "path": "v1/invitations",
+ "request": {
+ "$ref": "Invitation"
+ },
+ "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
+ "response": {
+ "$ref": "Invitation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {}
+ },
+ "accept": {
+ "flatPath": "v1/invitations/{id}:accept",
+ "path": "v1/invitations/{id}:accept",
+ "id": "classroom.invitations.accept",
+ "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the invitation to accept.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the invitation to delete.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/invitations/{id}",
+ "path": "v1/invitations/{id}",
+ "id": "classroom.invitations.delete",
+ "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Empty"
+ }
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListInvitationsResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "courseId": {
+ "location": "query",
+ "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "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."
+ },
+ "userId": {
+ "type": "string",
+ "location": "query",
+ "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/invitations",
+ "path": "v1/invitations",
+ "id": "classroom.invitations.list",
+ "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors."
+ },
+ "get": {
+ "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "response": {
+ "$ref": "Invitation"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the invitation to return.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/invitations/{id}",
+ "id": "classroom.invitations.get",
+ "path": "v1/invitations/{id}"
+ }
+ }
+ },
+ "userProfiles": {
+ "methods": {
+ "get": {
+ "parameterOrder": [
+ "userId"
+ ],
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the 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",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/userProfiles/{userId}",
+ "id": "classroom.userProfiles.get",
+ "path": "v1/userProfiles/{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."
+ }
+ },
+ "resources": {
+ "guardianInvitations": {
+ "methods": {
+ "create": {
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "parameters": {
+ "studentId": {
+ "description": "ID of the student (in standard format)",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "studentId"
+ ],
+ "response": {
+ "$ref": "GuardianInvitation"
+ }
+ },
+ "patch": {
+ "id": "classroom.userProfiles.guardianInvitations.patch",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
+ "request": {
+ "$ref": "GuardianInvitation"
+ },
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
+ "parameterOrder": [
+ "studentId",
+ "invitationId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "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,...`",
+ "type": "string",
+ "location": "query"
+ },
+ "invitationId": {
+ "description": "The `id` field of the `GuardianInvitation` to be modified.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "studentId": {
+ "description": "The ID of the student whose guardian invitation is to be modified.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "parameters": {
+ "invitationId": {
+ "location": "path",
+ "description": "The `id` field of the `GuardianInvitation` being requested.",
+ "type": "string",
+ "required": true
+ },
+ "studentId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the student whose guardian invitation is being requested."
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "id": "classroom.userProfiles.guardianInvitations.get",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.",
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
+ "parameterOrder": [
+ "studentId",
+ "invitationId"
+ ],
+ "httpMethod": "GET"
+ },
+ "list": {
+ "parameters": {
+ "studentId": {
+ "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "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": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results."
+ },
+ "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"
+ ]
+ },
+ "invitedEmailAddress": {
+ "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "id": "classroom.userProfiles.guardianInvitations.list",
+ "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "studentId"
+ ],
+ "response": {
+ "$ref": "ListGuardianInvitationsResponse"
+ }
+ }
+ }
+ },
+ "guardians": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "studentId": {
+ "location": "path",
+ "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true
+ },
+ "guardianId": {
+ "location": "path",
+ "description": "The `id` field from a `Guardian`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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`."
+ },
+ "get": {
+ "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
+ "response": {
+ "$ref": "Guardian"
+ },
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "guardianId": {
+ "description": "The `id` field from a `Guardian`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "studentId": {
+ "location": "path",
+ "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "id": "classroom.userProfiles.guardians.get",
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListGuardiansResponse"
+ },
+ "parameterOrder": [
+ "studentId"
+ ],
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "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"
+ },
+ "studentId": {
+ "location": "path",
+ "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "flatPath": "v1/userProfiles/{studentId}/guardians",
+ "path": "v1/userProfiles/{studentId}/guardians",
+ "id": "classroom.userProfiles.guardians.list",
+ "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student."
+ }
+ }
+ }
+ }
+ },
+ "courses": {
+ "resources": {
+ "aliases": {
+ "methods": {
+ "list": {
+ "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.",
+ "response": {
+ "$ref": "ListCourseAliasesResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\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": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results."
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.list",
+ "path": "v1/courses/{courseId}/aliases"
+ },
+ "create": {
+ "request": {
+ "$ref": "CourseAlias"
+ },
+ "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).",
+ "response": {
+ "$ref": "CourseAlias"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.create",
+ "path": "v1/courses/{courseId}/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": [
+ "courseId",
+ "alias"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "alias": {
+ "location": "path",
+ "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "flatPath": "v1/courses/{courseId}/aliases/{alias}",
+ "id": "classroom.courses.aliases.delete",
+ "path": "v1/courses/{courseId}/aliases/{alias}"
+ }
+ }
+ },
+ "students": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListStudentsResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer"
+ }
+ },
+ "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."
+ },
+ "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",
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "id": "classroom.courses.students.get",
+ "path": "v1/courses/{courseId}/students/{userId}"
+ },
+ "create": {
+ "response": {
+ "$ref": "Student"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "enrollmentCode": {
+ "location": "query",
+ "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.create",
+ "path": "v1/courses/{courseId}/students",
+ "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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "id": "classroom.courses.students.delete",
+ "path": "v1/courses/{courseId}/students/{userId}"
+ }
+ }
+ },
+ "courseWork": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.delete",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "courseWorkStates": {
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "COURSE_WORK_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ],
+ "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.",
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "id": "classroom.courses.courseWork.list",
+ "path": "v1/courses/{courseId}/courseWork",
+ "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
+ "response": {
+ "$ref": "ListCourseWorkResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET"
+ },
+ "get": {
+ "description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "id": {
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.get",
+ "path": "v1/courses/{courseId}/courseWork/{id}"
+ },
+ "patch": {
+ "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "CourseWork"
+ },
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "id": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Identifier of the course work."
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.patch",
+ "path": "v1/courses/{courseId}/courseWork/{id}"
+ },
+ "create": {
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "id": "classroom.courses.courseWork.create",
+ "path": "v1/courses/{courseId}/courseWork",
+ "request": {
+ "$ref": "CourseWork"
+ },
+ "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible"
+ }
+ },
+ "resources": {
+ "studentSubmissions": {
+ "methods": {
+ "patch": {
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "id": {
+ "description": "Identifier of the student submission.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`"
+ },
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "id": "classroom.courses.courseWork.studentSubmissions.patch",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "StudentSubmission"
+ }
+ },
+ "get": {
+ "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "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",
+ "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
+ "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
+ ],
+ "parameters": {
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "id": "classroom.courses.courseWork.studentSubmissions.get",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}"
+ },
+ "return": {
+ "request": {
+ "$ref": "ReturnStudentSubmissionRequest"
+ },
+ "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "parameters": {
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "id": {
+ "type": "string",
+ "required": true,
+ "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"
+ },
+ "reclaim": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ],
+ "parameters": {
+ "id": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Identifier of the student submission."
+ },
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
+ "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
+ "request": {
+ "$ref": "ReclaimStudentSubmissionRequest"
+ },
+ "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
+ },
+ "turnIn": {
+ "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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the student submission.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn"
+ },
+ "modifyAttachments": {
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
+ "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
+ "request": {
+ "$ref": "ModifyAttachmentsRequest"
+ },
+ "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "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": {
+ "id": {
+ "description": "Identifier of the student submission.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "courseId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ }
+ }
+ },
+ "list": {
+ "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
+ "response": {
+ "$ref": "ListStudentSubmissionsResponse"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "states": {
+ "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "SUBMISSION_STATE_UNSPECIFIED",
+ "NEW",
+ "CREATED",
+ "TURNED_IN",
+ "RETURNED",
+ "RECLAIMED_BY_STUDENT"
+ ]
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer"
+ },
+ "userId": {
+ "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "location": "query"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "late": {
+ "enum": [
+ "LATE_VALUES_UNSPECIFIED",
+ "LATE_ONLY",
+ "NOT_LATE_ONLY"
+ ],
+ "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
+ "type": "string",
+ "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\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
+ "id": "classroom.courses.courseWork.studentSubmissions.list",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions"
+ }
+ }
+ }
+ }
+ },
+ "teachers": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "userId": {
+ "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "id": "classroom.courses.teachers.delete",
+ "path": "v1/courses/{courseId}/teachers/{userId}"
+ },
+ "list": {
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTeachersResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "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."
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.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"
+ ]
+ },
+ "get": {
+ "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Teacher"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true
+ },
+ "courseId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "path": "v1/courses/{courseId}/teachers/{userId}",
+ "id": "classroom.courses.teachers.get"
+ },
+ "create": {
+ "response": {
+ "$ref": "Teacher"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.create",
+ "path": "v1/courses/{courseId}/teachers",
+ "request": {
+ "$ref": "Teacher"
+ },
+ "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse."
+ }
+ }
+ }
+ },
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Course"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {},
+ "flatPath": "v1/courses",
+ "path": "v1/courses",
+ "id": "classroom.courses.create",
+ "request": {
+ "$ref": "Course"
+ },
+ "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists."
+ },
+ "get": {
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Course"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.get"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{id}",
+ "id": "classroom.courses.patch",
+ "path": "v1/courses/{id}",
+ "request": {
+ "$ref": "Course"
+ },
+ "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable"
+ },
+ "update": {
+ "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
+ "request": {
+ "$ref": "Course"
+ },
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "id": {
+ "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "flatPath": "v1/courses/{id}",
+ "id": "classroom.courses.update",
+ "path": "v1/courses/{id}"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "id": {
+ "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.delete",
+ "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListCoursesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "studentId": {
+ "location": "query",
+ "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "courseStates": {
+ "enum": [
+ "COURSE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "ARCHIVED",
+ "PROVISIONED",
+ "DECLINED",
+ "SUSPENDED"
+ ],
+ "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
+ "type": "string",
+ "repeated": true,
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "flatPath": "v1/courses",
+ "id": "classroom.courses.list",
+ "path": "v1/courses",
+ "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist."
+ }
+ }
+ }
+ }
}
diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json
index ed2c9b0..f669b9d 100644
--- a/cloudbuild/v1/cloudbuild-api.json
+++ b/cloudbuild/v1/cloudbuild-api.json
@@ -1,27 +1,514 @@
{
- "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CancelBuildRequest": {
+ "StorageSource": {
+ "description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage.",
+ "type": "object",
+ "properties": {
+ "generation": {
+ "format": "int64",
+ "description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used.",
+ "type": "string"
+ },
+ "bucket": {
+ "description": "Google Cloud Storage bucket containing source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
+ "type": "string"
+ },
+ "object": {
+ "description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild.",
+ "type": "string"
+ }
+ },
+ "id": "StorageSource"
+ },
+ "Results": {
+ "description": "Results describes the artifacts created by the build pipeline.",
+ "type": "object",
+ "properties": {
+ "buildStepImages": {
+ "description": "List of build step digests, in order corresponding to build step indices.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "images": {
+ "description": "Images that were built as a part of the build.",
+ "items": {
+ "$ref": "BuiltImage"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Results"
+ },
+ "BuildOperationMetadata": {
+ "description": "Metadata for build operations.",
+ "type": "object",
+ "properties": {
+ "build": {
+ "description": "The build that the operation is tracking.",
+ "$ref": "Build"
+ }
+ },
+ "id": "BuildOperationMetadata"
+ },
+ "SourceProvenance": {
+ "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
+ "type": "object",
+ "properties": {
+ "fileHashes": {
+ "additionalProperties": {
+ "$ref": "FileHashes"
+ },
+ "description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build. Note that FileHashes will\nonly be populated if BuildOptions has requested a SourceProvenanceHash.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will be for the single path to that file.\n@OutputOnly",
+ "type": "object"
+ },
+ "resolvedRepoSource": {
+ "description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved.",
+ "$ref": "RepoSource"
+ },
+ "resolvedStorageSource": {
+ "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved.",
+ "$ref": "StorageSource"
+ }
+ },
+ "id": "SourceProvenance"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
"type": "object",
"properties": {},
- "id": "CancelBuildRequest",
- "description": "Request to cancel an ongoing build."
+ "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": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ }
+ },
+ "id": "Operation"
+ },
+ "ListBuildTriggersResponse": {
+ "description": "Response containing existing BuildTriggers.",
+ "type": "object",
+ "properties": {
+ "triggers": {
+ "description": "BuildTriggers for the project, sorted by create_time descending.",
+ "items": {
+ "$ref": "BuildTrigger"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListBuildTriggersResponse"
+ },
+ "BuiltImage": {
+ "description": "BuiltImage describes an image built by the pipeline.",
+ "type": "object",
+ "properties": {
+ "digest": {
+ "description": "Docker Registry 2.0 digest.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`.",
+ "type": "string"
+ }
+ },
+ "id": "BuiltImage"
+ },
+ "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\".",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "args": {
+ "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the container image that will run this particular build step.\n\nIf the image is already available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.",
+ "type": "string"
+ },
+ "entrypoint": {
+ "description": "Optional entrypoint to be used instead of the build step image's default\nIf unset, the image's default will be used.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.",
+ "type": "string"
+ },
+ "secretEnv": {
+ "description": "A list of environment variables which are encrypted using a Cloud KMS\ncrypto key. These values must be specified in the build's secrets.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "volumes": {
+ "description": "List of volumes to mount into the build step.\n\nEach volume will be created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents will\nbe discarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a mis-configured build request.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BuildStep"
+ },
+ "RepoSource": {
+ "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
+ "type": "object",
+ "properties": {
+ "commitSha": {
+ "description": "Explicit commit SHA to build.",
+ "type": "string"
+ },
+ "tagName": {
+ "description": "Name of the tag to build.",
+ "type": "string"
+ },
+ "branchName": {
+ "description": "Name of the branch to build.",
+ "type": "string"
+ },
+ "repoName": {
+ "description": "Name of the repo. If omitted, the name \"default\" is assumed.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed.",
+ "type": "string"
+ }
+ },
+ "id": "RepoSource"
+ },
+ "Hash": {
+ "description": "Container message for hash values.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ],
+ "enum": [
+ "NONE",
+ "SHA256"
+ ],
+ "description": "The type of hash that was performed.",
+ "type": "string"
+ },
+ "value": {
+ "format": "byte",
+ "description": "The hash value.",
+ "type": "string"
+ }
+ },
+ "id": "Hash"
+ },
+ "FileHashes": {
+ "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.",
+ "type": "object",
+ "properties": {
+ "fileHash": {
+ "description": "Collection of file hashes.",
+ "items": {
+ "$ref": "Hash"
+ },
+ "type": "array"
+ }
+ },
+ "id": "FileHashes"
+ },
+ "Secret": {
+ "description": "Secret pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.",
+ "type": "object",
+ "properties": {
+ "secretEnv": {
+ "additionalProperties": {
+ "format": "byte",
+ "type": "string"
+ },
+ "description": "Map of environment variable name to its encrypted value.\n\nSecret environment variables must be unique across all of a build's\nsecrets, and must be used by at least one build step. Values can be at most\n1 KB in size. There can be at most ten secret values across all of a\nbuild's secrets.",
+ "type": "object"
+ },
+ "kmsKeyName": {
+ "description": "Cloud KMS key name to use to decrypt these envs.",
+ "type": "string"
+ }
+ },
+ "id": "Secret"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Status"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "BuildTrigger": {
+ "description": "Configuration for an automated build in response to source repository\nchanges.",
+ "type": "object",
+ "properties": {
+ "build": {
+ "description": "Contents of the build template.",
+ "$ref": "Build"
+ },
+ "substitutions": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for Build resource.",
+ "type": "object"
+ },
+ "description": {
+ "description": "Human-readable description of this trigger.",
+ "type": "string"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Time when the trigger was created.\n\n@OutputOnly",
+ "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."
+ },
+ "filename": {
+ "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the trigger.\n\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "BuildTrigger"
+ },
+ "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": {
+ "timeout": {
+ "format": "google-duration",
+ "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be TIMEOUT.\n\nDefault time is ten minutes.",
+ "type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Status of the build is unknown.",
+ "Build is queued; work has not yet begun.",
+ "Build is being executed.",
+ "Build finished successfully.",
+ "Build failed to complete successfully.",
+ "Build failed due to an internal cause.",
+ "Build took longer than was allowed.",
+ "Build was canceled by a user."
+ ],
+ "enum": [
+ "STATUS_UNKNOWN",
+ "QUEUED",
+ "WORKING",
+ "SUCCESS",
+ "FAILURE",
+ "INTERNAL_ERROR",
+ "TIMEOUT",
+ "CANCELLED"
+ ],
+ "description": "Status of the build.\n@OutputOnly",
+ "type": "string"
+ },
+ "statusDetail": {
+ "description": "Customer-readable message about the current status.\n@OutputOnly",
+ "type": "string"
+ },
+ "secrets": {
+ "description": "Secrets to decrypt using Cloud KMS.",
+ "items": {
+ "$ref": "Secret"
+ },
+ "type": "array"
+ },
+ "logsBucket": {
+ "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.",
+ "type": "string"
+ },
+ "results": {
+ "$ref": "Results",
+ "description": "Results of the build.\n@OutputOnly"
+ },
+ "steps": {
+ "description": "Describes the operations to be performed on the workspace.",
+ "items": {
+ "$ref": "BuildStep"
+ },
+ "type": "array"
+ },
+ "buildTriggerId": {
+ "description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Tags for annotation of a Build. These are not docker tags.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier of the build.\n@OutputOnly",
+ "type": "string"
+ },
+ "substitutions": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for Build resource.",
+ "type": "object"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Time at which execution of the build was started.\n@OutputOnly",
+ "type": "string"
+ },
+ "sourceProvenance": {
+ "description": "A permanent fixed identifier for source.\n@OutputOnly",
+ "$ref": "SourceProvenance"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Time at which the request to create the build was received.\n@OutputOnly",
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "projectId": {
+ "description": "ID of the project.\n@OutputOnly.",
+ "type": "string"
+ },
+ "logUrl": {
+ "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly",
+ "type": "string"
+ },
+ "finishTime": {
+ "format": "google-datetime",
+ "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly",
+ "type": "string"
+ },
+ "options": {
+ "$ref": "BuildOptions",
+ "description": "Special options for this build."
+ },
+ "source": {
+ "description": "Describes where to find the source files to build.",
+ "$ref": "Source"
+ }
+ },
+ "id": "Build"
+ },
+ "CancelBuildRequest": {
+ "description": "Request to cancel an ongoing build.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelBuildRequest"
},
"ListBuildsResponse": {
"description": "Response including listed builds.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token to receive the next page of results.",
- "type": "string"
- },
"builds": {
+ "description": "Builds will be sorted by create_time, descending.",
"items": {
"$ref": "Build"
},
- "type": "array",
- "description": "Builds will be sorted by create_time, descending."
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token to receive the next page of results.",
+ "type": "string"
}
},
"id": "ListBuildsResponse"
@@ -35,8 +522,8 @@
"type": "string"
},
"path": {
- "type": "string",
- "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths."
+ "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.",
+ "type": "string"
}
},
"id": "Volume"
@@ -60,6 +547,7 @@
"id": "ListOperationsResponse"
},
"Source": {
+ "description": "Source describes the location of the source in a supported storage\nservice.",
"type": "object",
"properties": {
"storageSource": {
@@ -67,42 +555,46 @@
"description": "If provided, get the source from this location in in Google Cloud\nStorage."
},
"repoSource": {
- "$ref": "RepoSource",
- "description": "If provided, get source from this location in a Cloud Repo."
+ "description": "If provided, get source from this location in a Cloud Repo.",
+ "$ref": "RepoSource"
}
},
- "id": "Source",
- "description": "Source describes the location of the source in a supported storage\nservice."
+ "id": "Source"
},
"BuildOptions": {
"description": "Optional arguments to enable specific features of builds.",
"type": "object",
"properties": {
"substitutionOption": {
- "enum": [
- "MUST_MATCH",
- "ALLOW_LOOSE"
- ],
"description": "SubstitutionOption to allow unmatch substitutions.",
"type": "string",
"enumDescriptions": [
"Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.",
"Do not fail the build if error in substitutions checks."
+ ],
+ "enum": [
+ "MUST_MATCH",
+ "ALLOW_LOOSE"
]
},
"requestedVerifyOption": {
+ "enumDescriptions": [
+ "Not a verifiable build. (default)",
+ "Verified build."
+ ],
"enum": [
"NOT_VERIFIED",
"VERIFIED"
],
"description": "Requested verifiability options.",
- "type": "string",
- "enumDescriptions": [
- "Not a verifiable build. (default)",
- "Verified build."
- ]
+ "type": "string"
},
"sourceProvenanceHash": {
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ],
+ "description": "Requested hash for SourceProvenance.",
"items": {
"type": "string",
"enum": [
@@ -110,503 +602,10 @@
"SHA256"
]
},
- "type": "array",
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ],
- "description": "Requested hash for SourceProvenance."
+ "type": "array"
}
},
"id": "BuildOptions"
- },
- "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": {
- "type": "string",
- "description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild."
- },
- "generation": {
- "type": "string",
- "format": "int64",
- "description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used."
- }
- },
- "id": "StorageSource"
- },
- "Results": {
- "description": "Results describes the artifacts created by the build pipeline.",
- "type": "object",
- "properties": {
- "buildStepImages": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "List of build step digests, in order corresponding to build step indices."
- },
- "images": {
- "items": {
- "$ref": "BuiltImage"
- },
- "type": "array",
- "description": "Images that were built as a part of the build."
- }
- },
- "id": "Results"
- },
- "BuildOperationMetadata": {
- "type": "object",
- "properties": {
- "build": {
- "$ref": "Build",
- "description": "The build that the operation is tracking."
- }
- },
- "id": "BuildOperationMetadata",
- "description": "Metadata for build operations."
- },
- "SourceProvenance": {
- "type": "object",
- "properties": {
- "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."
- },
- "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",
- "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build."
- },
- "CancelOperationRequest": {
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation."
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "response": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`."
- },
- "name": {
- "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": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any."
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- }
- },
- "id": "Operation"
- },
- "ListBuildTriggersResponse": {
- "description": "Response containing existing BuildTriggers.",
- "type": "object",
- "properties": {
- "triggers": {
- "description": "BuildTriggers for the project, sorted by create_time descending.",
- "items": {
- "$ref": "BuildTrigger"
- },
- "type": "array"
- }
- },
- "id": "ListBuildTriggersResponse"
- },
- "BuiltImage": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`."
- },
- "digest": {
- "type": "string",
- "description": "Docker Registry 2.0 digest."
- }
- },
- "id": "BuiltImage",
- "description": "BuiltImage describes an image built by the pipeline."
- },
- "Hash": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ],
- "enum": [
- "NONE",
- "SHA256"
- ],
- "description": "The type of hash that was performed."
- },
- "value": {
- "format": "byte",
- "description": "The hash value.",
- "type": "string"
- }
- },
- "id": "Hash",
- "description": "Container message for hash values."
- },
- "RepoSource": {
- "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
- "type": "object",
- "properties": {
- "commitSha": {
- "description": "Explicit commit SHA to build.",
- "type": "string"
- },
- "tagName": {
- "type": "string",
- "description": "Name of the tag to build."
- },
- "branchName": {
- "type": "string",
- "description": "Name of the branch to build."
- },
- "repoName": {
- "description": "Name of the repo. If omitted, the name \"default\" is assumed.",
- "type": "string"
- },
- "projectId": {
- "type": "string",
- "description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed."
- }
- },
- "id": "RepoSource"
- },
- "BuildStep": {
- "type": "object",
- "properties": {
- "dir": {
- "description": "Working directory (relative to project source root) to use when running\nthis operation's container.",
- "type": "string"
- },
- "waitFor": {
- "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in wait_for\nhave completed successfully. If wait_for is empty, this build step will\nstart when all previous build steps in the Build.Steps list have completed\nsuccessfully.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "env": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\"."
- },
- "args": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments."
- },
- "name": {
- "type": "string",
- "description": "The name of the container image that will run this particular build step.\n\nIf the image is already available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step."
- },
- "entrypoint": {
- "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."
- },
- "secretEnv": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "A list of environment variables which are encrypted using a Cloud KMS\ncrypto key. These values must be specified in the build's secrets."
- },
- "id": {
- "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.",
- "type": "string"
- },
- "volumes": {
- "items": {
- "$ref": "Volume"
- },
- "type": "array",
- "description": "List of volumes to mount into the build step.\n\nEach volume will be created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents will\nbe discarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a mis-configured build request."
- }
- },
- "id": "BuildStep",
- "description": "BuildStep describes a step to perform in the build pipeline."
- },
- "FileHashes": {
- "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.",
- "type": "object",
- "properties": {
- "fileHash": {
- "description": "Collection of file hashes.",
- "items": {
- "$ref": "Hash"
- },
- "type": "array"
- }
- },
- "id": "FileHashes"
- },
- "Secret": {
- "type": "object",
- "properties": {
- "secretEnv": {
- "type": "object",
- "additionalProperties": {
- "format": "byte",
- "type": "string"
- },
- "description": "Map of environment variable name to its encrypted value.\n\nSecret environment variables must be unique across all of a build's\nsecrets, and must be used by at least one build step. Values can be at most\n1 KB in size. There can be at most ten secret values across all of a\nbuild's secrets."
- },
- "kmsKeyName": {
- "type": "string",
- "description": "Cloud KMS key name to use to decrypt these envs."
- }
- },
- "id": "Secret",
- "description": "Secret pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value."
- },
- "Status": {
- "type": "object",
- "properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- },
- "details": {
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
- },
- "type": "array",
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
- }
- },
- "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."
- },
- "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 `{}`."
- },
- "BuildTrigger": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Unique identifier of the trigger.\n\n@OutputOnly"
- },
- "build": {
- "$ref": "Build",
- "description": "Contents of the build template."
- },
- "substitutions": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Substitutions data for Build resource."
- },
- "description": {
- "description": "Human-readable description of this trigger.",
- "type": "string"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Time when the trigger was created.\n\n@OutputOnly",
- "type": "string"
- },
- "disabled": {
- "type": "boolean",
- "description": "If true, the trigger will never result in a build."
- },
- "filename": {
- "type": "string",
- "description": "Path, from the source root, to a file whose contents is used for the\ntemplate."
- },
- "triggerTemplate": {
- "$ref": "RepoSource",
- "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build."
- }
- },
- "id": "BuildTrigger",
- "description": "Configuration for an automated build in response to source repository\nchanges."
- },
- "Build": {
- "type": "object",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Describes where to find the source files to build."
- },
- "options": {
- "$ref": "BuildOptions",
- "description": "Special options for this build."
- },
- "statusDetail": {
- "description": "Customer-readable message about the current status.\n@OutputOnly",
- "type": "string"
- },
- "status": {
- "type": "string",
- "enumDescriptions": [
- "Status of the build is unknown.",
- "Build is queued; work has not yet begun.",
- "Build is being executed.",
- "Build finished successfully.",
- "Build failed to complete successfully.",
- "Build failed due to an internal cause.",
- "Build took longer than was allowed.",
- "Build was canceled by a user."
- ],
- "enum": [
- "STATUS_UNKNOWN",
- "QUEUED",
- "WORKING",
- "SUCCESS",
- "FAILURE",
- "INTERNAL_ERROR",
- "TIMEOUT",
- "CANCELLED"
- ],
- "description": "Status of the build.\n@OutputOnly"
- },
- "timeout": {
- "type": "string",
- "format": "google-duration",
- "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be TIMEOUT.\n\nDefault time is ten minutes."
- },
- "secrets": {
- "description": "Secrets to decrypt using Cloud KMS.",
- "items": {
- "$ref": "Secret"
- },
- "type": "array"
- },
- "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"
- },
- "steps": {
- "description": "Describes the operations to be performed on the workspace.",
- "items": {
- "$ref": "BuildStep"
- },
- "type": "array"
- },
- "buildTriggerId": {
- "description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "Unique identifier of the build.\n@OutputOnly"
- },
- "tags": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Tags for annotation of a Build. These are not docker tags."
- },
- "substitutions": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Substitutions data for Build resource."
- },
- "startTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Time at which execution of the build was started.\n@OutputOnly"
- },
- "sourceProvenance": {
- "$ref": "SourceProvenance",
- "description": "A permanent fixed identifier for source.\n@OutputOnly"
- },
- "createTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Time at which the request to create the build was received.\n@OutputOnly"
- },
- "images": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "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": {
- "type": "string",
- "description": "ID of the project.\n@OutputOnly."
- },
- "finishTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly"
- },
- "logUrl": {
- "type": "string",
- "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly"
- }
- },
- "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."
}
},
"protocol": "rest",
@@ -631,140 +630,151 @@
"title": "Google Cloud Container Builder API",
"ownerName": "Google",
"resources": {
- "operations": {
- "methods": {
- "get": {
- "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource."
- }
- }
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The standard list page token."
- },
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation's parent resource."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "cloudbuild.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- },
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled."
- }
- },
- "flatPath": "v1/operations/{operationsId}:cancel",
- "id": "cloudbuild.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`."
- }
- }
- },
"projects": {
"resources": {
- "triggers": {
+ "builds": {
"methods": {
- "delete": {
+ "cancel": {
+ "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
+ "id": "cloudbuild.projects.builds.cancel",
+ "path": "v1/projects/{projectId}/builds/{id}:cancel",
+ "description": "Cancels a requested build in progress.",
+ "request": {
+ "$ref": "CancelBuildRequest"
+ },
"response": {
- "$ref": "Empty"
+ "$ref": "Build"
},
"parameterOrder": [
"projectId",
- "triggerId"
+ "id"
],
- "httpMethod": "DELETE",
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "id": {
+ "location": "path",
+ "description": "ID of the build.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "ListBuildsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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",
+ "format": "int32",
+ "description": "Number of results to return in the list.",
+ "type": "integer"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/builds",
+ "path": "v1/projects/{projectId}/builds",
+ "id": "cloudbuild.projects.builds.list"
+ },
+ "get": {
+ "description": "Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Build"
+ },
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"projectId": {
+ "location": "path",
+ "description": "ID of the project.",
"type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the project that owns the trigger."
+ "required": true
},
- "triggerId": {
+ "id": {
"location": "path",
- "description": "ID of the BuildTrigger to delete.",
+ "description": "ID of the build.",
"type": "string",
"required": true
}
},
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.delete",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
+ "flatPath": "v1/projects/{projectId}/builds/{id}",
+ "path": "v1/projects/{projectId}/builds/{id}",
+ "id": "cloudbuild.projects.builds.get"
},
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/builds",
+ "path": "v1/projects/{projectId}/builds",
+ "id": "cloudbuild.projects.builds.create",
+ "request": {
+ "$ref": "Build"
+ },
+ "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure)."
+ }
+ }
+ },
+ "triggers": {
+ "methods": {
"patch": {
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
"response": {
"$ref": "BuildTrigger"
},
@@ -773,87 +783,86 @@
"triggerId"
],
"httpMethod": "PATCH",
- "parameters": {
- "triggerId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the BuildTrigger to update."
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the project that owns the trigger."
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "triggerId": {
+ "location": "path",
+ "description": "ID of the BuildTrigger to update.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "ID of the project that owns the trigger.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
"id": "cloudbuild.projects.triggers.patch",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
- "request": {
- "$ref": "BuildTrigger"
- }
+ "path": "v1/projects/{projectId}/triggers/{triggerId}"
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
+ "description": "Lists existing BuildTrigger.\n\nThis API is experimental.",
"response": {
"$ref": "ListBuildTriggersResponse"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
"parameters": {
"projectId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "ID of the project for which to list BuildTriggers."
+ "description": "ID of the project for which to list BuildTriggers.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/triggers",
- "path": "v1/projects/{projectId}/triggers",
"id": "cloudbuild.projects.triggers.list",
- "description": "Lists existing BuildTrigger.\n\nThis API is experimental."
+ "path": "v1/projects/{projectId}/triggers"
},
"get": {
- "description": "Gets information about a BuildTrigger.\n\nThis API is experimental.",
- "response": {
- "$ref": "BuildTrigger"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"projectId",
"triggerId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "BuildTrigger"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the project that owns the trigger."
- },
"triggerId": {
+ "location": "path",
+ "description": "ID of the BuildTrigger to get.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "ID of the project that owns the trigger.",
"type": "string",
"required": true,
- "location": "path",
- "description": "ID of the BuildTrigger to get."
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
"id": "cloudbuild.projects.triggers.get",
- "path": "v1/projects/{projectId}/triggers/{triggerId}"
+ "description": "Gets information about a BuildTrigger.\n\nThis API is experimental."
},
"create": {
+ "flatPath": "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"
@@ -867,175 +876,209 @@
"httpMethod": "POST",
"parameters": {
"projectId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "ID of the project for which to configure automatic builds."
+ "description": "ID of the project for which to configure automatic builds.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
],
- "flatPath": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.create",
- "path": "v1/projects/{projectId}/triggers"
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "triggerId": {
+ "location": "path",
+ "description": "ID of the BuildTrigger to delete.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project that owns the trigger.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.delete",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}"
}
}
+ }
+ }
+ },
+ "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": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "cloudbuild.operations.get",
+ "path": "v1/{+name}"
},
- "builds": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBuildsResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the project."
- },
- "filter": {
- "location": "query",
- "description": "The raw filter text to constrain the results.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Token to provide to skip to a particular spot in the list.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Number of results to return in the list.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.list",
- "path": "v1/projects/{projectId}/builds",
- "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully."
+ "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"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
},
- "get": {
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the project."
- },
- "id": {
- "location": "path",
- "description": "ID of the build.",
- "type": "string",
- "required": true
- }
- },
- "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."
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
},
- "create": {
- "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).",
- "request": {
- "$ref": "Build"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the project."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds",
- "path": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.create"
+ "name": {
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations$"
},
- "cancel": {
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the project.",
- "type": "string",
- "required": true
- },
- "id": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the build."
- }
- },
- "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
- "id": "cloudbuild.projects.builds.cancel",
- "path": "v1/projects/{projectId}/builds/{id}:cancel",
- "request": {
- "$ref": "CancelBuildRequest"
- },
- "description": "Cancels a requested build in progress."
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
}
- }
+ },
+ "flatPath": "v1/operations",
+ "path": "v1/{+name}",
+ "id": "cloudbuild.operations.list"
+ },
+ "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"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
}
},
"parameters": {
- "access_token": {
- "type": "string",
+ "uploadType": {
"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.",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "quotaUser": {
- "type": "string",
+ "fields": {
"location": "query",
- "description": "Available 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": "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": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "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",
@@ -1049,73 +1092,30 @@
"type": "string"
},
"oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "location": "query"
},
"upload_protocol": {
- "type": "string",
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
},
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "fields": {
- "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": {
- "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://cloudbuild.googleapis.com/",
- "kind": "discovery#restDescription",
"description": "Builds container images in the cloud.",
+ "kind": "discovery#restDescription",
"servicePath": "",
"basePath": "",
"id": "cloudbuild:v1",
- "revision": "20170823",
- "documentationLink": "https://cloud.google.com/container-builder/docs/"
+ "documentationLink": "https://cloud.google.com/container-builder/docs/",
+ "revision": "20170824",
+ "discoveryVersion": "v1"
}
diff --git a/cloudbuild/v1/cloudbuild-gen.go b/cloudbuild/v1/cloudbuild-gen.go
index 3a44616..b28b8c3 100644
--- a/cloudbuild/v1/cloudbuild-gen.go
+++ b/cloudbuild/v1/cloudbuild-gen.go
@@ -792,8 +792,8 @@
type Operation struct {
// Done: If the value is `false`, it means the operation is still in
// progress.
- // If true, the operation is completed, and either `error` or `response`
- // is
+ // If `true`, the operation is completed, and either `error` or
+ // `response` is
// available.
Done bool `json:"done,omitempty"`
diff --git a/clouddebugger/v2/clouddebugger-api.json b/clouddebugger/v2/clouddebugger-api.json
index 08709a1..97d4f81 100644
--- a/clouddebugger/v2/clouddebugger-api.json
+++ b/clouddebugger/v2/clouddebugger-api.json
@@ -1,428 +1,460 @@
{
+ "ownerDomain": "google.com",
+ "name": "clouddebugger",
+ "batchPath": "batch",
+ "title": "Stackdriver Debugger API",
+ "ownerName": "Google",
+ "resources": {
+ "debugger": {
+ "resources": {
+ "debuggees": {
+ "methods": {
+ "list": {
+ "id": "clouddebugger.debugger.debuggees.list",
+ "path": "v2/debugger/debuggees",
+ "description": "Lists all the debuggees that the user has access to.",
+ "response": {
+ "$ref": "ListDebuggeesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string",
+ "location": "query"
+ },
+ "includeInactive": {
+ "location": "query",
+ "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
+ "type": "boolean"
+ },
+ "project": {
+ "location": "query",
+ "description": "Project number of a Google Cloud project whose debuggees to list.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/debugger/debuggees"
+ }
+ },
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "delete": {
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
+ "description": "Deletes the breakpoint from the debuggee.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "breakpointId": {
+ "description": "ID of the breakpoint to delete.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoint to delete.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}"
+ },
+ "set": {
+ "description": "Sets the breakpoint to the debuggee.",
+ "request": {
+ "$ref": "Breakpoint"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "response": {
+ "$ref": "SetBreakpointResponse"
+ },
+ "parameters": {
+ "debuggeeId": {
+ "location": "path",
+ "description": "ID of the debuggee where the breakpoint is to be set.",
+ "type": "string",
+ "required": true
+ },
+ "clientVersion": {
+ "location": "query",
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.set"
+ },
+ "list": {
+ "description": "Lists all breakpoints for the debuggee.",
+ "response": {
+ "$ref": "ListBreakpointsResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "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": {
+ "location": "query",
+ "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
+ "type": "boolean"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoints to list.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "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.\nSchema: `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"
+ }
+ },
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.list",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints"
+ },
+ "get": {
+ "parameters": {
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string",
+ "location": "query"
+ },
+ "breakpointId": {
+ "location": "path",
+ "description": "ID of the breakpoint to get.",
+ "type": "string",
+ "required": true
+ },
+ "debuggeeId": {
+ "location": "path",
+ "description": "ID of the debuggee whose breakpoint to get.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.get",
+ "description": "Gets breakpoint information.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "response": {
+ "$ref": "GetBreakpointResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "controller": {
+ "resources": {
+ "debuggees": {
+ "methods": {
+ "register": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {},
+ "flatPath": "v2/controller/debuggees/register",
+ "path": "v2/controller/debuggees/register",
+ "id": "clouddebugger.controller.debuggees.register",
+ "request": {
+ "$ref": "RegisterDebuggeeRequest"
+ },
+ "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application must call this method with\nexactly the same request content to get back the same stable `debuggee_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND`\nis returned from any controller method.\n\nThis protocol allows the controller service to disable debuggees, recover\nfrom data loss, or change the `debuggee_id` format. Agents must handle\n`debuggee_id` value changing upon re-registration.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "RegisterDebuggeeResponse"
+ }
+ }
+ },
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "response": {
+ "$ref": "ListActiveBreakpointsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "waitToken": {
+ "location": "query",
+ "description": "A token that, if specified, blocks the method call until the list\nof active breakpoints has changed, or a server-selected timeout has\nexpired. The value should be set from the `next_wait_token` field in\nthe last response. The initial value should be set to `\"init\"`.",
+ "type": "string"
+ },
+ "successOnTimeout": {
+ "description": "If set to `true` (recommended), returns `google.rpc.Code.OK` status and\nsets the `wait_expired` response field to `true` when the server-selected\ntimeout has expired.\n\nIf set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status\nwhen the server-selected timeout has expired.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "debuggeeId": {
+ "location": "path",
+ "description": "Identifies the debuggee.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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 `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again."
+ },
+ "update": {
+ "response": {
+ "$ref": "UpdateActiveBreakpointResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId",
+ "id"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "debuggeeId": {
+ "location": "path",
+ "description": "Identifies the debuggee being debugged.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "id": "clouddebugger.controller.debuggees.breakpoints.update",
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "request": {
+ "$ref": "UpdateActiveBreakpointRequest"
+ },
+ "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller service.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expressions` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
"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",
+ "kind": "discovery#restDescription",
"servicePath": "",
"basePath": "",
- "id": "clouddebugger:v2",
"revision": "20170817",
"documentationLink": "http://cloud.google.com/debugger",
+ "id": "clouddebugger:v2",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "StatusMessage": {
- "type": "object",
- "properties": {
- "description": {
- "$ref": "FormatMessage",
- "description": "Status message text."
- },
- "isError": {
- "description": "Distinguishes errors from informational messages.",
- "type": "boolean"
- },
- "refersTo": {
- "enumDescriptions": [
- "Status doesn't refer to any particular input.",
- "Status applies to the breakpoint and is related to its location.",
- "Status applies to the breakpoint and is related to its condition.",
- "Status applies to the breakpoint and is related to its expressions.",
- "Status applies to the breakpoint and is related to its age.",
- "Status applies to the entire variable.",
- "Status applies to variable value (variable name is valid)."
- ],
- "enum": [
- "UNSPECIFIED",
- "BREAKPOINT_SOURCE_LOCATION",
- "BREAKPOINT_CONDITION",
- "BREAKPOINT_EXPRESSION",
- "BREAKPOINT_AGE",
- "VARIABLE_NAME",
- "VARIABLE_VALUE"
- ],
- "description": "Reference to which the message applies.",
- "type": "string"
- }
- },
- "id": "StatusMessage",
- "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`."
- },
- "GitSourceContext": {
- "id": "GitSourceContext",
- "description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).",
- "type": "object",
- "properties": {
- "url": {
- "description": "Git repository URL.",
- "type": "string"
- },
- "revisionId": {
- "description": "Git commit hash.\nrequired.",
- "type": "string"
- }
- }
- },
- "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.",
- "items": {
- "$ref": "Variable"
- },
- "type": "array"
- },
- "status": {
- "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`",
- "$ref": "StatusMessage"
- },
- "name": {
- "type": "string",
- "description": "Name of the variable, if any."
- },
- "type": {
- "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.",
- "type": "string"
- },
- "value": {
- "description": "Simple value of the variable.",
- "type": "string"
- },
- "varTableIndex": {
- "type": "integer",
- "format": "int32",
- "description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint."
- }
- },
- "id": "Variable"
- },
- "StackFrame": {
- "id": "StackFrame",
- "description": "Represents a stack frame context.",
- "type": "object",
- "properties": {
- "arguments": {
- "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
- "items": {
- "$ref": "Variable"
- },
- "type": "array"
- },
- "locals": {
- "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
- "items": {
- "$ref": "Variable"
- },
- "type": "array"
- },
- "location": {
- "$ref": "SourceLocation",
- "description": "Source location of the call site."
- },
- "function": {
- "description": "Demangled function name at the call site.",
- "type": "string"
- }
- }
- },
- "RepoId": {
- "description": "A unique identifier for a cloud repo.",
- "type": "object",
- "properties": {
- "uid": {
- "description": "A server-assigned, globally unique identifier.",
- "type": "string"
- },
- "projectRepoId": {
- "description": "A combination of a project ID and a repo name.",
- "$ref": "ProjectRepoId"
- }
- },
- "id": "RepoId"
- },
- "FormatMessage": {
- "description": "Represents a message with parameters.",
- "type": "object",
- "properties": {
- "parameters": {
- "description": "Optional parameters to be embedded into the message.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "format": {
- "type": "string",
- "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.`"
- }
- },
- "id": "FormatMessage"
- },
- "ExtendedSourceContext": {
- "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels with user defined metadata.",
- "type": "object"
- },
- "context": {
- "description": "Any source context.",
- "$ref": "SourceContext"
- }
- },
- "id": "ExtendedSourceContext"
- },
- "AliasContext": {
- "description": "An alias to a repo revision.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The alias name.",
- "type": "string"
- },
- "kind": {
- "description": "The alias kind.",
- "type": "string",
- "enumDescriptions": [
- "Do not use.",
- "Git tag",
- "Git branch",
- "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
- ],
- "enum": [
- "ANY",
- "FIXED",
- "MOVABLE",
- "OTHER"
- ]
- }
- },
- "id": "AliasContext"
- },
- "ListDebuggeesResponse": {
- "type": "object",
- "properties": {
- "debuggees": {
- "items": {
- "$ref": "Debuggee"
- },
- "type": "array",
- "description": "List of debuggees accessible to the calling user.\nThe fields `debuggee.id` and `description` are guaranteed to be set.\nThe `description` field is a human readable field provided by agents and\ncan be displayed to users."
- }
- },
- "id": "ListDebuggeesResponse",
- "description": "Response for listing debuggees."
- },
- "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": {
- "type": "string",
- "description": "Path to the source file within the source context of the target binary."
- },
- "line": {
- "format": "int32",
- "description": "Line inside the file. The first line in the file has the value `1`.",
- "type": "integer"
- }
- },
- "id": "SourceLocation"
- },
- "Debuggee": {
- "id": "Debuggee",
- "description": "Represents the debugged application. The application may include one or more\nreplicated processes executing the same code. Each of these processes is\nattached with a debugger agent, carrying out the debugging commands.\nAgents attached to the same debuggee identify themselves as such by using\nexactly the same Debuggee message value when registering.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.",
- "type": "string"
- },
- "uniquifier": {
- "description": "Uniquifier to further distiguish the application.\nIt is possible that different applications might have identical values in\nthe debuggee message, thus, incorrectly identified as a single application\nby the Controller service. This field adds salt to further distiguish the\napplication. Agents should consider seeding this field with value that\nidentifies the code, binary, configuration and environment.",
- "type": "string"
- },
- "sourceContexts": {
- "items": {
- "$ref": "SourceContext"
- },
- "type": "array",
- "description": "References to the locations and revisions of the source code used in the\ndeployed application."
- },
- "extSourceContexts": {
- "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nNOTE: this field is experimental and can be ignored.",
- "items": {
- "$ref": "ExtendedSourceContext"
- },
- "type": "array"
- },
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user."
- },
- "isInactive": {
- "description": "If set to `true`, indicates that Controller service does not detect any\nactivity from the debuggee agents and the application is possibly stopped.",
- "type": "boolean"
- },
- "status": {
- "$ref": "StatusMessage",
- "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status."
- },
- "project": {
- "description": "Project the debuggee is associated with.\nUse project number or id when registering a Google Cloud Platform project.",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the debuggee generated by the controller service.",
- "type": "string"
- },
- "agentVersion": {
- "description": "Version ID of the agent.\nSchema: `domain/language-platform/vmajor.minor` (for example\n`google.com/java-gcp/v1.1`).",
- "type": "string"
- },
- "isDisabled": {
- "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
- "type": "boolean"
- }
- }
- },
- "ListActiveBreakpointsResponse": {
- "description": "Response for listing active breakpoints.",
- "type": "object",
- "properties": {
- "nextWaitToken": {
- "description": "A 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.",
- "items": {
- "$ref": "Breakpoint"
- },
- "type": "array"
- },
- "waitExpired": {
- "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored.",
- "type": "boolean"
- }
- },
- "id": "ListActiveBreakpointsResponse"
- },
- "ProjectRepoId": {
- "type": "object",
- "properties": {
- "repoName": {
- "description": "The name of the repo. Leave empty for the default repo.",
- "type": "string"
- },
- "projectId": {
- "type": "string",
- "description": "The ID of the project."
- }
- },
- "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."
- },
- "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."
- },
- "workspaceId": {
- "description": "The ID of the workspace.",
- "$ref": "CloudWorkspaceId"
- }
- },
- "id": "CloudWorkspaceSourceContext"
- },
- "GerritSourceContext": {
- "description": "A SourceContext referring to a Gerrit project.",
- "type": "object",
- "properties": {
- "aliasContext": {
- "$ref": "AliasContext",
- "description": "An alias, which may be a branch or tag."
- },
- "gerritProject": {
- "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
- "type": "string"
- },
- "revisionId": {
- "type": "string",
- "description": "A revision (commit) ID."
- },
- "hostUri": {
- "description": "The URI of a running Gerrit instance.",
- "type": "string"
- },
- "aliasName": {
- "description": "The name of an alias (branch, tag, etc.).",
- "type": "string"
- }
- },
- "id": "GerritSourceContext"
- },
- "UpdateActiveBreakpointResponse": {
- "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
- "type": "object",
- "properties": {},
- "id": "UpdateActiveBreakpointResponse"
- },
- "CloudWorkspaceId": {
- "id": "CloudWorkspaceId",
- "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.",
- "type": "object",
- "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"
- }
- }
- },
- "ListBreakpointsResponse": {
- "properties": {
- "breakpoints": {
- "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of its status.",
- "items": {
- "$ref": "Breakpoint"
- },
- "type": "array"
- },
- "nextWaitToken": {
- "description": "A wait token that can be used in the next call to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of breakpoints has changes.",
- "type": "string"
- }
- },
- "id": "ListBreakpointsResponse",
- "description": "Response for listing breakpoints.",
- "type": "object"
- },
"Breakpoint": {
"description": "Represents the breakpoint specification, status and results.",
"type": "object",
"properties": {
+ "action": {
+ "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.",
+ "type": "string",
+ "enumDescriptions": [
+ "Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.",
+ "Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired."
+ ],
+ "enum": [
+ "CAPTURE",
+ "LOG"
+ ]
+ },
+ "logLevel": {
+ "description": "Indicates the severity of the log. Only relevant when action is `LOG`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Information log message.",
+ "Warning log message.",
+ "Error log message."
+ ],
+ "enum": [
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ]
+ },
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "type": "string"
+ },
"location": {
"$ref": "SourceLocation",
"description": "Breakpoint source location."
@@ -447,8 +479,8 @@
}
},
"logMessageFormat": {
- "type": "string",
- "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 ]`."
+ "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.",
+ "type": "string"
},
"createTime": {
"format": "google-datetime",
@@ -470,8 +502,8 @@
"type": "array"
},
"isFinalState": {
- "type": "boolean",
- "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on."
+ "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on.",
+ "type": "boolean"
},
"stackFrames": {
"description": "The stack at breakpoint time.",
@@ -481,61 +513,20 @@
"type": "array"
},
"condition": {
- "type": "string",
- "description": "Condition that triggers the breakpoint.\nThe condition is a compound boolean expression composed using expressions\nin a programming language at the source location."
+ "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"
+ "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition",
+ "$ref": "StatusMessage"
},
"userEmail": {
"description": "E-mail address of the user that created this breakpoint",
"type": "string"
- },
- "action": {
- "enumDescriptions": [
- "Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.",
- "Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired."
- ],
- "enum": [
- "CAPTURE",
- "LOG"
- ],
- "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.",
- "type": "string"
- },
- "logLevel": {
- "enum": [
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Indicates the severity of the log. Only relevant when action is `LOG`.",
- "type": "string",
- "enumDescriptions": [
- "Information log message.",
- "Warning log message.",
- "Error log message."
- ]
- },
- "id": {
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "type": "string"
}
},
"id": "Breakpoint"
},
- "SetBreakpointResponse": {
- "type": "object",
- "properties": {
- "breakpoint": {
- "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds).",
- "$ref": "Breakpoint"
- }
- },
- "id": "SetBreakpointResponse",
- "description": "Response for setting a breakpoint."
- },
"UpdateActiveBreakpointRequest": {
"description": "Request to update an active breakpoint.",
"type": "object",
@@ -547,10 +538,25 @@
},
"id": "UpdateActiveBreakpointRequest"
},
+ "SetBreakpointResponse": {
+ "description": "Response for setting a breakpoint.",
+ "type": "object",
+ "properties": {
+ "breakpoint": {
+ "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds).",
+ "$ref": "Breakpoint"
+ }
+ },
+ "id": "SetBreakpointResponse"
+ },
"SourceContext": {
"description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.",
"type": "object",
"properties": {
+ "gerrit": {
+ "$ref": "GerritSourceContext",
+ "description": "A SourceContext referring to a Gerrit project."
+ },
"cloudWorkspace": {
"description": "A SourceContext referring to a snapshot in a cloud workspace.",
"$ref": "CloudWorkspaceSourceContext"
@@ -562,16 +568,11 @@
"git": {
"description": "A SourceContext referring to any third party Git repo (e.g. GitHub).",
"$ref": "GitSourceContext"
- },
- "gerrit": {
- "$ref": "GerritSourceContext",
- "description": "A SourceContext referring to a Gerrit project."
}
},
"id": "SourceContext"
},
"CloudRepoSourceContext": {
- "id": "CloudRepoSourceContext",
"description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
"type": "object",
"properties": {
@@ -591,10 +592,21 @@
"$ref": "AliasContext",
"description": "An alias, which may be a branch or tag."
}
+ },
+ "id": "CloudRepoSourceContext"
+ },
+ "RegisterDebuggeeRequest": {
+ "id": "RegisterDebuggeeRequest",
+ "description": "Request to register a debuggee.",
+ "type": "object",
+ "properties": {
+ "debuggee": {
+ "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set.",
+ "$ref": "Debuggee"
+ }
}
},
"RegisterDebuggeeResponse": {
- "id": "RegisterDebuggeeResponse",
"description": "Response for registering a debuggee.",
"type": "object",
"properties": {
@@ -602,35 +614,433 @@
"description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields).\nIf the field `is_disabled` is set to `true`, the agent should disable\nitself by removing all breakpoints and detaching from the application.\nIt should however continue to poll `RegisterDebuggee` until reenabled.",
"$ref": "Debuggee"
}
- }
- },
- "RegisterDebuggeeRequest": {
- "description": "Request to register a debuggee.",
- "type": "object",
- "properties": {
- "debuggee": {
- "$ref": "Debuggee",
- "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
- }
},
- "id": "RegisterDebuggeeRequest"
+ "id": "RegisterDebuggeeResponse"
},
"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"
+ },
+ "StatusMessage": {
+ "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Status message text.",
+ "$ref": "FormatMessage"
+ },
+ "isError": {
+ "description": "Distinguishes errors from informational messages.",
+ "type": "boolean"
+ },
+ "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.",
+ "Status applies to the breakpoint and is related to its condition.",
+ "Status applies to the breakpoint and is related to its expressions.",
+ "Status applies to the breakpoint and is related to its age.",
+ "Status applies to the entire variable.",
+ "Status applies to variable value (variable name is valid)."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "BREAKPOINT_SOURCE_LOCATION",
+ "BREAKPOINT_CONDITION",
+ "BREAKPOINT_EXPRESSION",
+ "BREAKPOINT_AGE",
+ "VARIABLE_NAME",
+ "VARIABLE_VALUE"
+ ]
+ }
+ },
+ "id": "StatusMessage"
+ },
+ "GitSourceContext": {
+ "description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).",
+ "type": "object",
+ "properties": {
+ "revisionId": {
+ "description": "Git commit hash.\nrequired.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Git repository URL.",
+ "type": "string"
+ }
+ },
+ "id": "GitSourceContext"
+ },
+ "Variable": {
+ "id": "Variable",
+ "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Simple value of the variable.",
+ "type": "string"
+ },
+ "varTableIndex": {
+ "format": "int32",
+ "description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint.",
+ "type": "integer"
+ },
+ "members": {
+ "description": "Members contained or pointed to by the variable.",
+ "items": {
+ "$ref": "Variable"
+ },
+ "type": "array"
+ },
+ "status": {
+ "$ref": "StatusMessage",
+ "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`"
+ },
+ "name": {
+ "description": "Name of the variable, if any.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.",
+ "type": "string"
+ }
+ }
+ },
+ "StackFrame": {
+ "description": "Represents a stack frame context.",
+ "type": "object",
+ "properties": {
+ "locals": {
+ "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
+ "items": {
+ "$ref": "Variable"
+ },
+ "type": "array"
+ },
+ "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.",
+ "items": {
+ "$ref": "Variable"
+ },
+ "type": "array"
+ }
+ },
+ "id": "StackFrame"
+ },
+ "RepoId": {
+ "description": "A unique identifier for a cloud repo.",
+ "type": "object",
+ "properties": {
+ "projectRepoId": {
+ "description": "A combination of a project ID and a repo name.",
+ "$ref": "ProjectRepoId"
+ },
+ "uid": {
+ "description": "A server-assigned, globally unique identifier.",
+ "type": "string"
+ }
+ },
+ "id": "RepoId"
+ },
+ "FormatMessage": {
+ "description": "Represents a message with parameters.",
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "description": "Optional parameters to be embedded into the message.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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": {
+ "id": "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"
+ }
+ }
+ },
+ "ListDebuggeesResponse": {
+ "id": "ListDebuggeesResponse",
+ "description": "Response for listing debuggees.",
+ "type": "object",
+ "properties": {
+ "debuggees": {
+ "description": "List of debuggees accessible to the calling user.\nThe fields `debuggee.id` and `description` are guaranteed to be set.\nThe `description` field is a human readable field provided by agents and\ncan be displayed to users.",
+ "items": {
+ "$ref": "Debuggee"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "AliasContext": {
+ "id": "AliasContext",
+ "description": "An alias to a repo revision.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The alias name.",
+ "type": "string"
+ },
+ "kind": {
+ "enumDescriptions": [
+ "Do not use.",
+ "Git tag",
+ "Git branch",
+ "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
+ ],
+ "enum": [
+ "ANY",
+ "FIXED",
+ "MOVABLE",
+ "OTHER"
+ ],
+ "description": "The alias kind.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {}
+ },
+ "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": {
+ "format": "int32",
+ "description": "Line inside the file. The first line in the file has the value `1`.",
+ "type": "integer"
+ }
+ },
+ "id": "SourceLocation"
+ },
+ "Debuggee": {
+ "description": "Represents the debugged application. The application may include one or more\nreplicated processes executing the same code. Each of these processes is\nattached with a debugger agent, carrying out the debugging commands.\nAgents attached to the same debuggee identify themselves as such by using\nexactly the same Debuggee message value when registering.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.",
+ "type": "string"
+ },
+ "uniquifier": {
+ "description": "Uniquifier to further distiguish the application.\nIt is possible that different applications might have identical values in\nthe debuggee message, thus, incorrectly identified as a single application\nby the Controller service. This field adds salt to further distiguish the\napplication. Agents should consider seeding this field with value that\nidentifies the code, binary, configuration and environment.",
+ "type": "string"
+ },
+ "sourceContexts": {
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.",
+ "items": {
+ "$ref": "SourceContext"
+ },
+ "type": "array"
+ },
+ "extSourceContexts": {
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nNOTE: this field is experimental and can be ignored.",
+ "items": {
+ "$ref": "ExtendedSourceContext"
+ },
+ "type": "array"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
+ },
+ "isInactive": {
+ "description": "If set to `true`, indicates that Controller service does not detect any\nactivity from the debuggee agents and the application is possibly stopped.",
+ "type": "boolean"
+ },
+ "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 project number or id when registering a Google Cloud Platform project.",
+ "type": "string"
+ },
+ "isDisabled": {
+ "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
+ "type": "boolean"
+ },
+ "agentVersion": {
+ "description": "Version ID of the agent.\nSchema: `domain/language-platform/vmajor.minor` (for example\n`google.com/java-gcp/v1.1`).",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the debuggee generated by the controller service.",
+ "type": "string"
+ }
+ },
+ "id": "Debuggee"
+ },
+ "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": {
+ "repoName": {
+ "description": "The name of the repo. Leave empty for the default repo.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the project.",
+ "type": "string"
+ }
+ },
+ "id": "ProjectRepoId"
+ },
+ "ListActiveBreakpointsResponse": {
+ "description": "Response for listing active breakpoints.",
+ "type": "object",
+ "properties": {
+ "breakpoints": {
+ "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.",
+ "items": {
+ "$ref": "Breakpoint"
+ },
+ "type": "array"
+ },
+ "waitExpired": {
+ "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored.",
+ "type": "boolean"
+ },
+ "nextWaitToken": {
+ "description": "A token that can be used in the next method call to block until\nthe list of breakpoints changes.",
+ "type": "string"
+ }
+ },
+ "id": "ListActiveBreakpointsResponse"
+ },
+ "CloudWorkspaceSourceContext": {
+ "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
+ "type": "object",
+ "properties": {
+ "snapshotId": {
+ "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
+ "type": "string"
+ },
+ "workspaceId": {
+ "description": "The ID of the workspace.",
+ "$ref": "CloudWorkspaceId"
+ }
+ },
+ "id": "CloudWorkspaceSourceContext"
+ },
+ "UpdateActiveBreakpointResponse": {
+ "id": "UpdateActiveBreakpointResponse",
+ "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
+ "type": "object",
+ "properties": {}
+ },
+ "GerritSourceContext": {
+ "id": "GerritSourceContext",
+ "description": "A SourceContext referring to a Gerrit project.",
+ "type": "object",
+ "properties": {
+ "aliasName": {
+ "description": "The name of an alias (branch, tag, etc.).",
+ "type": "string"
+ },
+ "aliasContext": {
+ "description": "An alias, which may be a branch or tag.",
+ "$ref": "AliasContext"
+ },
+ "gerritProject": {
+ "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "A revision (commit) ID.",
+ "type": "string"
+ },
+ "hostUri": {
+ "description": "The URI of a running Gerrit instance.",
+ "type": "string"
+ }
+ }
+ },
+ "CloudWorkspaceId": {
+ "id": "CloudWorkspaceId",
+ "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.",
+ "type": "object",
+ "properties": {
+ "repoId": {
+ "$ref": "RepoId",
+ "description": "The ID of the repo containing the workspace."
+ },
+ "name": {
+ "description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.",
+ "type": "string"
+ }
+ }
+ },
+ "ListBreakpointsResponse": {
+ "id": "ListBreakpointsResponse",
+ "description": "Response for listing breakpoints.",
+ "type": "object",
+ "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 its status.",
+ "items": {
+ "$ref": "Breakpoint"
+ },
+ "type": "array"
+ }
+ }
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"canonicalName": "Cloud Debugger",
"auth": {
@@ -645,415 +1055,5 @@
}
}
},
- "rootUrl": "https://clouddebugger.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "clouddebugger",
- "batchPath": "batch",
- "title": "Stackdriver Debugger API",
- "ownerName": "Google",
- "resources": {
- "controller": {
- "resources": {
- "debuggees": {
- "methods": {
- "register": {
- "flatPath": "v2/controller/debuggees/register",
- "id": "clouddebugger.controller.debuggees.register",
- "path": "v2/controller/debuggees/register",
- "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application must call this method with\nexactly the same request content to get back the same stable `debuggee_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND`\nis returned from any controller method.\n\nThis protocol allows the controller service to disable debuggees, recover\nfrom data loss, or change the `debuggee_id` format. Agents must handle\n`debuggee_id` value changing upon re-registration.",
- "request": {
- "$ref": "RegisterDebuggeeRequest"
- },
- "response": {
- "$ref": "RegisterDebuggeeResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- }
- },
- "resources": {
- "breakpoints": {
- "methods": {
- "list": {
- "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `condition`, and `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again.",
- "response": {
- "$ref": "ListActiveBreakpointsResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "waitToken": {
- "description": "A token that, if specified, blocks the method call until the list\nof active breakpoints has changed, or a server-selected timeout has\nexpired. The value should be set from the `next_wait_token` field in\nthe last response. The initial value should be set to `\"init\"`.",
- "type": "string",
- "location": "query"
- },
- "successOnTimeout": {
- "location": "query",
- "description": "If set to `true` (recommended), returns `google.rpc.Code.OK` status and\nsets the `wait_expired` response field to `true` when the server-selected\ntimeout has expired.\n\nIf set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status\nwhen the server-selected timeout has expired.",
- "type": "boolean"
- },
- "debuggeeId": {
- "location": "path",
- "description": "Identifies the debuggee.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "id": "clouddebugger.controller.debuggees.breakpoints.list",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints"
- },
- "update": {
- "response": {
- "$ref": "UpdateActiveBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId",
- "id"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "type": "string",
- "required": true
- },
- "debuggeeId": {
- "description": "Identifies the debuggee being debugged.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "id": "clouddebugger.controller.debuggees.breakpoints.update",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "request": {
- "$ref": "UpdateActiveBreakpointRequest"
- },
- "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller service.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expressions` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code."
- }
- }
- }
- }
- }
- }
- },
- "debugger": {
- "resources": {
- "debuggees": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListDebuggeesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "includeInactive": {
- "location": "query",
- "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
- "type": "boolean"
- },
- "project": {
- "type": "string",
- "location": "query",
- "description": "Project number of a Google Cloud project whose debuggees to list."
- },
- "clientVersion": {
- "description": "The client version making the call.\nSchema: `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",
- "id": "clouddebugger.debugger.debuggees.list",
- "path": "v2/debugger/debuggees",
- "description": "Lists all the debuggees that the user has access to."
- }
- },
- "resources": {
- "breakpoints": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- },
- "breakpointId": {
- "description": "ID of the breakpoint to delete.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoint to delete.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "description": "Deletes the breakpoint from the debuggee."
- },
- "set": {
- "response": {
- "$ref": "SetBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee where the breakpoint is to be set.",
- "type": "string",
- "required": true
- },
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- }
- },
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- "id": "clouddebugger.debugger.debuggees.breakpoints.set",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- "request": {
- "$ref": "Breakpoint"
- },
- "description": "Sets the breakpoint to the debuggee."
- },
- "list": {
- "description": "Lists all breakpoints for the debuggee.",
- "httpMethod": "GET",
- "parameterOrder": [
- "debuggeeId"
- ],
- "response": {
- "$ref": "ListBreakpointsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "stripResults": {
- "location": "query",
- "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
- "type": "boolean"
- },
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoints to list.",
- "type": "string",
- "required": true,
- "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"
- },
- "clientVersion": {
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
- },
- "action.value": {
- "description": "Only breakpoints with the specified action will pass the filter.",
- "type": "string",
- "location": "query",
- "enum": [
- "CAPTURE",
- "LOG"
- ]
- },
- "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"
- }
- },
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "id": "clouddebugger.debugger.debuggees.breakpoints.list"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "GetBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "clientVersion": {
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
- },
- "breakpointId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the breakpoint to get."
- },
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoint to get.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "id": "clouddebugger.debugger.debuggees.breakpoints.get",
- "description": "Gets breakpoint information."
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "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": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "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": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- }
- }
+ "rootUrl": "https://clouddebugger.googleapis.com/"
}
diff --git a/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
index b22dba8..6b70232 100644
--- a/clouderrorreporting/v1beta1/clouderrorreporting-api.json
+++ b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
@@ -1,4 +1,15 @@
{
+ "canonicalName": "Clouderrorreporting",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://clouderrorreporting.googleapis.com/",
"ownerDomain": "google.com",
"name": "clouderrorreporting",
"batchPath": "batch",
@@ -8,53 +19,77 @@
"projects": {
"methods": {
"deleteEvents": {
- "httpMethod": "DELETE",
+ "description": "Deletes all error events of a given project.",
"response": {
"$ref": "DeleteEventsResponse"
},
"parameterOrder": [
"projectName"
],
+ "httpMethod": "DELETE",
+ "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`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "projectName": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "type": "string",
- "required": true
- }
- },
"flatPath": "v1beta1/projects/{projectsId}/events",
- "path": "v1beta1/{+projectName}/events",
"id": "clouderrorreporting.projects.deleteEvents",
- "description": "Deletes all error events of a given project."
+ "path": "v1beta1/{+projectName}/events"
}
},
"resources": {
- "groupStats": {
+ "events": {
"methods": {
- "list": {
- "description": "Lists the specified groups.",
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "ListGroupStatsResponse"
- },
+ "report": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "pageToken": {
- "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
+ "projectName": {
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
"type": "string",
- "location": "query"
- },
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/events:report",
+ "id": "clouderrorreporting.projects.events.report",
+ "path": "v1beta1/{+projectName}/events:report",
+ "request": {
+ "$ref": "ReportedErrorEvent"
+ },
+ "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e",
+ "response": {
+ "$ref": "ReportErrorEventResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "POST"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListEventsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
"timeRange.period": {
+ "description": "Restricts the query to the specified time range.",
+ "type": "string",
"location": "query",
"enum": [
"PERIOD_UNSPECIFIED",
@@ -63,24 +98,23 @@
"PERIOD_1_DAY",
"PERIOD_1_WEEK",
"PERIOD_30_DAYS"
- ],
- "description": "Restricts the query to the specified time range.",
- "type": "string"
+ ]
},
- "alignment": {
- "location": "query",
- "enum": [
- "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
- "ALIGNMENT_EQUAL_ROUNDED",
- "ALIGNMENT_EQUAL_AT_END"
- ],
- "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
- "type": "string"
+ "projectName": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "type": "string",
+ "required": true
},
"groupId": {
- "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
+ "location": "query",
+ "description": "[Required] The group for which events shall be returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "[Optional] A `next_page_token` provided by a previous response.",
"type": "string",
- "repeated": true,
"location": "query"
},
"serviceFilter.service": {
@@ -89,10 +123,46 @@
"location": "query"
},
"pageSize": {
+ "format": "int32",
+ "description": "[Optional] The maximum number of results to return per response.",
+ "type": "integer",
+ "location": "query"
+ },
+ "serviceFilter.version": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/events",
+ "path": "v1beta1/{+projectName}/events",
+ "id": "clouderrorreporting.projects.events.list",
+ "description": "Lists the specified events."
+ }
+ }
+ },
+ "groupStats": {
+ "methods": {
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "serviceFilter.service": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
"format": "int32",
"description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"order": {
"location": "query",
@@ -130,15 +200,57 @@
"required": true
},
"timedCountDuration": {
- "location": "query",
"format": "google-duration",
"description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
+ "type": "string"
+ },
+ "timeRange.period": {
+ "location": "query",
+ "enum": [
+ "PERIOD_UNSPECIFIED",
+ "PERIOD_1_HOUR",
+ "PERIOD_6_HOURS",
+ "PERIOD_1_DAY",
+ "PERIOD_1_WEEK",
+ "PERIOD_30_DAYS"
+ ],
+ "description": "Restricts the query to the specified time range.",
+ "type": "string"
+ },
+ "alignment": {
+ "location": "query",
+ "enum": [
+ "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
+ "ALIGNMENT_EQUAL_ROUNDED",
+ "ALIGNMENT_EQUAL_AT_END"
+ ],
+ "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
+ "type": "string"
+ },
+ "groupId": {
+ "repeated": true,
+ "location": "query",
+ "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
"type": "string"
}
},
"flatPath": "v1beta1/projects/{projectsId}/groupStats",
+ "path": "v1beta1/{+projectName}/groupStats",
"id": "clouderrorreporting.projects.groupStats.list",
- "path": "v1beta1/{+projectName}/groupStats"
+ "description": "Lists the specified groups.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectName"
+ ],
+ "response": {
+ "$ref": "ListGroupStatsResponse"
+ }
}
}
},
@@ -162,141 +274,40 @@
"id": "clouderrorreporting.projects.groups.get",
"description": "Get the specified group.",
"httpMethod": "GET",
- "parameterOrder": [
- "groupName"
- ],
"response": {
"$ref": "ErrorGroup"
- }
+ },
+ "parameterOrder": [
+ "groupName"
+ ]
},
"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"
},
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "ErrorGroup"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
"parameters": {
"name": {
- "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
- "type": "string",
- "required": true,
"pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}"
- }
- }
- },
- "events": {
- "methods": {
- "report": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectName"
- ],
- "response": {
- "$ref": "ReportErrorEventResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectName": {
- "pattern": "^projects/[^/]+$",
"location": "path",
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
"type": "string",
"required": true
}
},
- "flatPath": "v1beta1/projects/{projectsId}/events:report",
- "path": "v1beta1/{+projectName}/events:report",
- "id": "clouderrorreporting.projects.events.report",
- "request": {
- "$ref": "ReportedErrorEvent"
- },
- "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e"
- },
- "list": {
- "description": "Lists the specified events.",
- "response": {
- "$ref": "ListEventsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "groupId": {
- "location": "query",
- "description": "[Required] The group for which events shall be returned.",
- "type": "string"
- },
- "serviceFilter.service": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
- "type": "string"
- },
- "pageToken": {
- "description": "[Optional] A `next_page_token` provided by a previous response.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "[Optional] The maximum number of results to return per response.",
- "type": "integer"
- },
- "serviceFilter.version": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
- "type": "string",
- "location": "query"
- },
- "serviceFilter.resourceType": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
- "type": "string"
- },
- "timeRange.period": {
- "location": "query",
- "enum": [
- "PERIOD_UNSPECIFIED",
- "PERIOD_1_HOUR",
- "PERIOD_6_HOURS",
- "PERIOD_1_DAY",
- "PERIOD_1_WEEK",
- "PERIOD_30_DAYS"
- ],
- "description": "Restricts the query to the specified time range.",
- "type": "string"
- },
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/events",
- "id": "clouderrorreporting.projects.events.list",
- "path": "v1beta1/{+projectName}/events"
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "id": "clouderrorreporting.projects.groups.update",
+ "path": "v1beta1/{+name}"
}
}
}
@@ -304,26 +315,60 @@
}
},
"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.",
+ "callback": {
+ "description": "JSONP",
"type": "string",
"location": "query"
},
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
"access_token": {
"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"
+ "type": "string",
+ "location": "query"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
@@ -341,61 +386,27 @@
"type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "boolean"
},
"uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
"location": "query",
- "description": "JSONP",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "$.xgafv": {
- "description": "V1 error format.",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "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"
+ "location": "query"
}
},
"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": "",
+ "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
+ "kind": "discovery#restDescription",
"basePath": "",
"id": "clouderrorreporting:v1beta1",
"documentationLink": "https://cloud.google.com/error-reporting/",
@@ -403,38 +414,10 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ListEventsResponse": {
- "id": "ListEventsResponse",
- "description": "Contains a set of requested error events.",
- "type": "object",
- "properties": {
- "errorEvents": {
- "description": "The error events which match the given request.",
- "items": {
- "$ref": "ErrorEvent"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
- "type": "string"
- },
- "timeRangeBegin": {
- "format": "google-datetime",
- "description": "The timestamp specifies the start time to which the request was restricted.",
- "type": "string"
- }
- }
- },
"TimedCount": {
"description": "The number of errors in a given time period.\nAll numbers are approximate since the error events are sampled\nbefore counting them.",
"type": "object",
"properties": {
- "endTime": {
- "format": "google-datetime",
- "description": "End of the time period to which `count` refers (excluded).",
- "type": "string"
- },
"startTime": {
"format": "google-datetime",
"description": "Start of the time period to which `count` refers (included).",
@@ -444,12 +427,16 @@
"format": "int64",
"description": "Approximate number of occurrences in the given time period.",
"type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "End of the time period to which `count` refers (excluded).",
+ "type": "string"
}
},
"id": "TimedCount"
},
"ErrorGroup": {
- "id": "ErrorGroup",
"description": "Description of a group of similar error events.",
"type": "object",
"properties": {
@@ -468,9 +455,11 @@
"description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
"type": "string"
}
- }
+ },
+ "id": "ErrorGroup"
},
"SourceLocation": {
+ "id": "SourceLocation",
"description": "Indicates a location in the source code of the service for which errors are\nreported. `functionName` must be provided by the application when reporting\nan error, unless the error report contains a `message` with a supported\nexception stack trace. All fields are optional for the later case.",
"type": "object",
"properties": {
@@ -487,8 +476,7 @@
"description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java.",
"type": "string"
}
- },
- "id": "SourceLocation"
+ }
},
"ServiceContext": {
"id": "ServiceContext",
@@ -510,13 +498,12 @@
}
},
"ReportErrorEventResponse": {
- "id": "ReportErrorEventResponse",
"description": "Response for reporting an individual error event.\nData may be added to this message in the future.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "ReportErrorEventResponse"
},
"HttpRequestContext": {
- "id": "HttpRequestContext",
"description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
"type": "object",
"properties": {
@@ -545,7 +532,8 @@
"description": "The IP address from which the request originated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address, depending on the data that has been provided\nin the error report.",
"type": "string"
}
- }
+ },
+ "id": "HttpRequestContext"
},
"ListGroupStatsResponse": {
"id": "ListGroupStatsResponse",
@@ -571,10 +559,10 @@
}
},
"DeleteEventsResponse": {
- "id": "DeleteEventsResponse",
"description": "Response message for deleting error events.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "DeleteEventsResponse"
},
"SourceReference": {
"description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
@@ -592,6 +580,7 @@
"id": "SourceReference"
},
"ErrorEvent": {
+ "id": "ErrorEvent",
"description": "An error event which is returned by the Error Reporting system.",
"type": "object",
"properties": {
@@ -612,8 +601,7 @@
"description": "The `ServiceContext` for which this error was reported.",
"$ref": "ServiceContext"
}
- },
- "id": "ErrorEvent"
+ }
},
"ReportedErrorEvent": {
"description": "An error event which is reported to the Error Reporting system.",
@@ -633,21 +621,16 @@
"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"
},
"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"
- },
"sourceReferences": {
"description": "Source code that was used to build the executable which has\ncaused the given error message.",
"items": {
@@ -662,8 +645,13 @@
"httpRequest": {
"description": "The HTTP request which was processed when the error was\ntriggered.",
"$ref": "HttpRequestContext"
+ },
+ "user": {
+ "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
+ "type": "string"
}
- }
+ },
+ "id": "ErrorContext"
},
"TrackingIssue": {
"id": "TrackingIssue",
@@ -677,12 +665,36 @@
}
},
"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": {
+ "format": "int32",
+ "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
+ "type": "integer"
+ },
+ "affectedServices": {
+ "description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count.",
+ "items": {
+ "$ref": "ServiceContext"
+ },
+ "type": "array"
+ },
+ "representative": {
+ "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole.",
+ "$ref": "ErrorEvent"
+ },
+ "timedCounts": {
+ "description": "Approximate number of occurrences over time.\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requested time interval\n- Non-overlapping, and\n- Ordered by ascending time.",
+ "items": {
+ "$ref": "TimedCount"
+ },
+ "type": "array"
+ },
"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": {
"format": "google-datetime",
@@ -703,48 +715,36 @@
"format": "int64",
"description": "Approximate number of affected users in the given group that\nmatch the filter criteria.\nUsers are distinguished by data in the `ErrorContext` of the\nindividual error events, such as their login name or their remote\nIP address in case of HTTP requests.\nThe number of affected users can be zero even if the number of\nerrors is non-zero if no data was provided from which the\naffected user could be deduced.\nUsers are counted based on data in the request\ncontext that was provided in the error report. If more users are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",
"type": "string"
- },
- "numAffectedServices": {
- "format": "int32",
- "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
- "type": "integer"
- },
- "affectedServices": {
- "description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count.",
- "items": {
- "$ref": "ServiceContext"
- },
- "type": "array"
- },
- "representative": {
- "$ref": "ErrorEvent",
- "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole."
- },
- "timedCounts": {
- "description": "Approximate number of occurrences over time.\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requested time interval\n- Non-overlapping, and\n- Ordered by ascending time.",
- "items": {
- "$ref": "TimedCount"
- },
- "type": "array"
}
- },
- "id": "ErrorGroupStats"
- }
- },
- "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": "Clouderrorreporting",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ }
+ },
+ "ListEventsResponse": {
+ "id": "ListEventsResponse",
+ "description": "Contains a set of requested error events.",
+ "type": "object",
+ "properties": {
+ "timeRangeBegin": {
+ "format": "google-datetime",
+ "description": "The timestamp specifies the start time to which the request was restricted.",
+ "type": "string"
+ },
+ "errorEvents": {
+ "description": "The error events which match the given request.",
+ "items": {
+ "$ref": "ErrorEvent"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
+ "type": "string"
}
}
}
},
- "rootUrl": "https://clouderrorreporting.googleapis.com/"
+ "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"
}
diff --git a/cloudfunctions/v1/cloudfunctions-api.json b/cloudfunctions/v1/cloudfunctions-api.json
index 865143e..49d8c35 100644
--- a/cloudfunctions/v1/cloudfunctions-api.json
+++ b/cloudfunctions/v1/cloudfunctions-api.json
@@ -1,232 +1,9 @@
{
- "canonicalName": "Cloud Functions",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudfunctions.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudfunctions",
- "batchPath": "batch",
- "title": "Google Cloud Functions API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "path": "v1/{+name}/locations",
- "id": "cloudfunctions.projects.locations.list",
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudfunctions.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "list": {
- "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"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "query",
- "description": "The name of the operation's parent resource.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/operations",
- "id": "cloudfunctions.operations.list",
- "path": "v1/operations",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "API key. Your API 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": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudfunctions.googleapis.com/",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
- "kind": "discovery#restDescription",
"servicePath": "",
+ "kind": "discovery#restDescription",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
"basePath": "",
- "revision": "20170817",
+ "revision": "20170822",
"documentationLink": "https://cloud.google.com/functions",
"id": "cloudfunctions:v1",
"discoveryVersion": "v1",
@@ -236,6 +13,13 @@
"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"
@@ -245,19 +29,12 @@
"type": "string"
},
"metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
+ }
}
},
"id": "Location"
@@ -281,11 +58,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.",
@@ -299,21 +74,23 @@
"type": "string"
},
"error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
},
"metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ "id": "Operation"
},
"OperationMetadataV1Beta2": {
"properties": {
@@ -322,14 +99,16 @@
"type": "string"
},
"request": {
+ "description": "The original request that started the operation.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The original request that started the operation.",
- "type": "object"
+ }
},
"type": {
+ "description": "Type of operation.",
+ "type": "string",
"enumDescriptions": [
"Unknown operation type.",
"Triggered by CreateFunction call",
@@ -341,9 +120,7 @@
"CREATE_FUNCTION",
"UPDATE_FUNCTION",
"DELETE_FUNCTION"
- ],
- "description": "Type of operation.",
- "type": "string"
+ ]
}
},
"id": "OperationMetadataV1Beta2",
@@ -354,6 +131,10 @@
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -369,36 +150,256 @@
"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"
},
"ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
}
},
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
+ "id": "ListLocationsResponse"
}
},
- "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": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudfunctions.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudfunctions",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Functions API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "id": "cloudfunctions.projects.locations.list",
+ "path": "v1/{+name}/locations",
+ "description": "Lists information about the supported locations for this service."
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "cloudfunctions.operations.get",
+ "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.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name of the operation's parent resource.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations",
+ "id": "cloudfunctions.operations.list",
+ "path": "v1/operations"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://cloudfunctions.googleapis.com/"
}
diff --git a/cloudfunctions/v1beta2/cloudfunctions-api.json b/cloudfunctions/v1beta2/cloudfunctions-api.json
index 813eec2..3651301 100644
--- a/cloudfunctions/v1beta2/cloudfunctions-api.json
+++ b/cloudfunctions/v1beta2/cloudfunctions-api.json
@@ -1,655 +1,29 @@
{
- "canonicalName": "Cloud Functions",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudfunctions.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudfunctions",
- "batchPath": "batch",
- "title": "Google Cloud Functions API",
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/operations/{operationsId}",
- "id": "cloudfunctions.operations.get",
- "path": "v1beta2/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "list": {
- "id": "cloudfunctions.operations.list",
- "path": "v1beta2/operations",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "query",
- "description": "The name of the operation's parent resource.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "flatPath": "v1beta2/operations"
- }
- }
- },
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "id": "cloudfunctions.projects.locations.list",
- "path": "v1beta2/{+name}/locations",
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations"
- }
- },
- "resources": {
- "functions": {
- "methods": {
- "update": {
- "description": "Updates existing function.",
- "request": {
- "$ref": "CloudFunction"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "The name of the function to be updated.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "path": "v1beta2/{+name}",
- "id": "cloudfunctions.projects.locations.functions.update"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the function which should be deleted.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "path": "v1beta2/{+name}",
- "id": "cloudfunctions.projects.locations.functions.delete",
- "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function."
- },
- "list": {
- "description": "Returns a list of functions that belong to the requested project.",
- "response": {
- "$ref": "ListFunctionsResponse"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of functions to return per call.",
- "type": "integer"
- },
- "location": {
- "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
- "type": "string"
- }
- },
- "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": {
- "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
- "request": {
- "$ref": "CallFunctionRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function to be called.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
- "path": "v1beta2/{+name}:call",
- "id": "cloudfunctions.projects.locations.functions.call"
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "location": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "id": "cloudfunctions.projects.locations.functions.create",
- "path": "v1beta2/{+location}/functions",
- "request": {
- "$ref": "CloudFunction"
- },
- "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error."
- },
- "get": {
- "description": "Returns a function with the given name from the requested project.",
- "response": {
- "$ref": "CloudFunction"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the function which details should be obtained.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "id": "cloudfunctions.projects.locations.functions.get",
- "path": "v1beta2/{+name}"
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "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": "v1beta2",
- "baseUrl": "https://cloudfunctions.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
- "servicePath": "",
- "basePath": "",
- "documentationLink": "https://cloud.google.com/functions",
- "revision": "20170817",
"id": "cloudfunctions:v1beta2",
+ "documentationLink": "https://cloud.google.com/functions",
+ "revision": "20170822",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
- }
- },
- "id": "ListOperationsResponse"
- },
- "ListFunctionsResponse": {
- "description": "Response for the `ListFunctions` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.",
- "type": "string"
- },
- "functions": {
- "description": "The functions that match the request.",
- "items": {
- "$ref": "CloudFunction"
- },
- "type": "array"
- }
- },
- "id": "ListFunctionsResponse"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListLocationsResponse"
- },
- "CallFunctionResponse": {
- "properties": {
- "executionId": {
- "description": "Execution id of function invocation.",
- "type": "string"
- },
- "error": {
- "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
- "type": "string"
- },
- "result": {
- "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
- "type": "string"
- }
- },
- "id": "CallFunctionResponse",
- "description": "Response of `CallFunction` method.",
- "type": "object"
- },
- "EventTrigger": {
- "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
- "type": "object",
- "properties": {
- "resource": {
- "description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)",
- "type": "string"
- },
- "eventType": {
- "description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`\n\n Handle an object changing in Google Cloud Storage\n `providers/cloud.storage/eventTypes/object.change`\n\n Handle a write to the Firebase Realtime Database\n `providers/firebase.database/eventTypes/data.write`",
- "type": "string"
- }
- },
- "id": "EventTrigger"
- },
- "HTTPSTrigger": {
- "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
- "type": "object",
- "properties": {
- "url": {
- "description": "Output only. The deployed url for the function.",
- "type": "string"
- }
- },
- "id": "HTTPSTrigger"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "OperationMetadataV1Beta2": {
- "properties": {
- "target": {
- "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
- "type": "string"
- },
- "request": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The original request that started the operation.",
- "type": "object"
- },
- "type": {
- "enumDescriptions": [
- "Unknown operation type.",
- "Triggered by CreateFunction call",
- "Triggered by UpdateFunction call",
- "Triggered by DeleteFunction call."
- ],
- "enum": [
- "OPERATION_UNSPECIFIED",
- "CREATE_FUNCTION",
- "UPDATE_FUNCTION",
- "DELETE_FUNCTION"
- ],
- "description": "Type of operation.",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta2",
- "description": "Metadata describing an Operation",
- "type": "object"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "CallFunctionRequest": {
- "description": "Request for the `CallFunction` method.",
- "type": "object",
- "properties": {
- "data": {
- "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": {
- "revision": {
- "description": "The id of the revision that captures the state of the repository from\nwhich the function should be fetched.",
- "type": "string"
- },
- "repositoryUrl": {
- "description": "URL to the hosted repository where the function is defined. Only paths in\nhttps://source.developers.google.com domain are supported. The path should\ncontain the name of the repository.",
- "type": "string"
- },
- "tag": {
- "description": "The name of the tag that captures the state of the repository from\nwhich the function should be fetched.",
- "type": "string"
- },
- "branch": {
- "description": "The name of the branch from which the function should be fetched.",
- "type": "string"
- },
- "sourcePath": {
- "description": "The path within the repository where the function is defined. The path\nshould point to the directory where Cloud Functions files are located. Use\n\"/\" if the function is defined directly in the root directory of a\nrepository.",
- "type": "string"
- },
- "deployedRevision": {
- "description": "Output only. The id of the revision that was resolved at the moment of\nfunction creation or update. For example when a user deployed from a\nbranch, it will be the revision id of the latest change on this branch at\nthat time. If user deployed from revision then this value will be always\nequal to the revision specified by the user.",
- "type": "string"
- }
- },
- "id": "SourceRepository"
- },
"CloudFunction": {
- "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
"type": "object",
"properties": {
+ "serviceAccount": {
+ "description": "Output only. The service account of the function.",
+ "type": "string"
+ },
+ "sourceArchiveUrl": {
+ "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.",
+ "type": "string"
+ },
+ "sourceRepository": {
+ "$ref": "SourceRepository",
+ "description": "The hosted repository where the function is defined."
+ },
+ "entryPoint": {
+ "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
+ "type": "string"
+ },
"sourceRepositoryUrl": {
"description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/aliases/movable/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/aliases/fixed/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.",
"type": "string"
@@ -664,12 +38,13 @@
"type": "string"
},
"httpsTrigger": {
- "$ref": "HTTPSTrigger",
- "description": "An HTTPS endpoint type of source that can be triggered via URL."
+ "description": "An HTTPS endpoint type of source that can be triggered via URL.",
+ "$ref": "HTTPSTrigger"
},
- "eventTrigger": {
- "description": "A source that fires events in response to a condition in another service.",
- "$ref": "EventTrigger"
+ "timeout": {
+ "format": "google-duration",
+ "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
+ "type": "string"
},
"status": {
"enumDescriptions": [
@@ -689,10 +64,9 @@
"description": "Output only. Status of the function deployment.",
"type": "string"
},
- "timeout": {
- "format": "google-duration",
- "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
- "type": "string"
+ "eventTrigger": {
+ "$ref": "EventTrigger",
+ "description": "A source that fires events in response to a condition in another service."
},
"availableMemoryMb": {
"format": "int32",
@@ -702,27 +76,13 @@
"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": {
- "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"
- },
- "entryPoint": {
- "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
- "type": "string"
}
},
- "id": "CloudFunction"
+ "id": "CloudFunction",
+ "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations."
},
"Location": {
+ "type": "object",
"properties": {
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
@@ -749,13 +109,675 @@
}
},
"id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
+ "description": "A resource that represents Google Cloud Platform location."
+ },
+ "Retry": {
+ "id": "Retry",
+ "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.",
+ "type": "object",
+ "properties": {}
+ },
+ "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"
+ },
+ "ListFunctionsResponse": {
+ "id": "ListFunctionsResponse",
+ "description": "Response for the `ListFunctions` method.",
+ "type": "object",
+ "properties": {
+ "functions": {
+ "items": {
+ "$ref": "CloudFunction"
+ },
+ "type": "array",
+ "description": "The functions that match the request."
+ },
+ "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"
+ }
+ }
+ },
+ "CallFunctionResponse": {
+ "id": "CallFunctionResponse",
+ "description": "Response of `CallFunction` method.",
+ "type": "object",
+ "properties": {
+ "executionId": {
+ "description": "Execution id of function invocation.",
+ "type": "string"
+ },
+ "error": {
+ "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
+ "type": "string"
+ },
+ "result": {
+ "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
+ "type": "string"
+ }
+ }
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "EventTrigger": {
+ "properties": {
+ "resource": {
+ "type": "string",
+ "description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)"
+ },
+ "failurePolicy": {
+ "description": "Specifies policy for failed executions.",
+ "$ref": "FailurePolicy"
+ },
+ "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`"
+ }
+ },
+ "id": "EventTrigger",
+ "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
+ "type": "object"
+ },
+ "HTTPSTrigger": {
+ "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "Output only. The deployed url for the function.",
+ "type": "string"
+ }
+ },
+ "id": "HTTPSTrigger"
+ },
+ "FailurePolicy": {
+ "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
+ "type": "object",
+ "properties": {
+ "retry": {
+ "description": "If specified, then the function will be retried in case of a failure.",
+ "$ref": "Retry"
+ }
+ },
+ "id": "FailurePolicy"
+ },
+ "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": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation"
+ },
+ "OperationMetadataV1Beta2": {
+ "description": "Metadata describing an Operation",
+ "type": "object",
+ "properties": {
+ "target": {
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
+ "type": "string"
+ },
+ "request": {
+ "description": "The original request that started the operation.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": {
+ "description": "Type of operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ],
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "CREATE_FUNCTION",
+ "UPDATE_FUNCTION",
+ "DELETE_FUNCTION"
+ ]
+ }
+ },
+ "id": "OperationMetadataV1Beta2"
+ },
+ "Status": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "type": "string",
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ }
+ },
+ "id": "Status",
+ "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."
+ },
+ "CallFunctionRequest": {
+ "description": "Request for the `CallFunction` method.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "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": {
+ "deployedRevision": {
+ "description": "Output only. The id of the revision that was resolved at the moment of\nfunction creation or update. For example when a user deployed from a\nbranch, it will be the revision id of the latest change on this branch at\nthat time. If user deployed from revision then this value will be always\nequal to the revision specified by the user.",
+ "type": "string"
+ },
+ "sourcePath": {
+ "description": "The path within the repository where the function is defined. The path\nshould point to the directory where Cloud Functions files are located. Use\n\"/\" if the function is defined directly in the root directory of a\nrepository.",
+ "type": "string"
+ },
+ "revision": {
+ "description": "The id of the revision that captures the state of the repository from\nwhich the function should be fetched.",
+ "type": "string"
+ },
+ "repositoryUrl": {
+ "description": "URL to the hosted repository where the function is defined. Only paths in\nhttps://source.developers.google.com domain are supported. The path should\ncontain the name of the repository.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "The name of the tag that captures the state of the repository from\nwhich the function should be fetched.",
+ "type": "string"
+ },
+ "branch": {
+ "description": "The name of the branch from which the function should be fetched.",
+ "type": "string"
+ }
+ },
+ "id": "SourceRepository"
}
},
+ "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 Functions",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudfunctions.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudfunctions",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Functions API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "location": "path",
+ "description": "The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations",
+ "id": "cloudfunctions.projects.locations.list",
+ "path": "v1beta2/{+name}/locations",
+ "description": "Lists information about the supported locations for this service."
+ }
+ },
+ "resources": {
+ "functions": {
+ "methods": {
+ "list": {
+ "description": "Returns a list of functions that belong to the requested project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "location"
+ ],
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ },
+ "pageToken": {
+ "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of functions to return per call.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "path": "v1beta2/{+location}/functions",
+ "id": "cloudfunctions.projects.locations.functions.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "location"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "location": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "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",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function to be called."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
+ "id": "cloudfunctions.projects.locations.functions.call",
+ "path": "v1beta2/{+name}:call"
+ },
+ "get": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "id": "cloudfunctions.projects.locations.functions.get",
+ "path": "v1beta2/{+name}",
+ "description": "Returns a function with the given name from the requested project.",
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function which details should be obtained."
+ }
+ }
+ },
+ "update": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.update",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "description": "Updates existing function.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function to be updated.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function which should be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.delete"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/operations/{operationsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ },
+ "list": {
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the operation's parent resource."
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/operations",
+ "id": "cloudfunctions.operations.list",
+ "path": "v1beta2/operations",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "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"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ }
+ },
+ "version": "v1beta2",
+ "baseUrl": "https://cloudfunctions.googleapis.com/",
+ "servicePath": "",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "kind": "discovery#restDescription",
+ "basePath": ""
}
diff --git a/cloudfunctions/v1beta2/cloudfunctions-gen.go b/cloudfunctions/v1beta2/cloudfunctions-gen.go
index f578887..8254bcc 100644
--- a/cloudfunctions/v1beta2/cloudfunctions-gen.go
+++ b/cloudfunctions/v1beta2/cloudfunctions-gen.go
@@ -339,6 +339,9 @@
// `providers/firebase.database/eventTypes/data.write`
EventType string `json:"eventType,omitempty"`
+ // FailurePolicy: Specifies policy for failed executions.
+ FailurePolicy *FailurePolicy `json:"failurePolicy,omitempty"`
+
// Resource: Which instance of the source's service should send events.
// E.g. for Pub/Sub
// this would be a Pub/Sub topic at `projects/*/topics/*`. For Google
@@ -373,6 +376,38 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// FailurePolicy: Describes the policy in case of function's execution
+// failure.
+// If empty, then defaults to ignoring failures (i.e. not retrying
+// them).
+type FailurePolicy struct {
+ // Retry: If specified, then the function will be retried in case of a
+ // failure.
+ Retry *Retry `json:"retry,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Retry") 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. "Retry") 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 *FailurePolicy) MarshalJSON() ([]byte, error) {
+ type noMethod FailurePolicy
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// HTTPSTrigger: Describes HTTPSTrigger, could be used to connect web
// hooks to function.
type HTTPSTrigger struct {
@@ -677,6 +712,16 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// Retry: Describes the retry policy in case of function's execution
+// failure.
+// A function execution will be retried on any failure.
+// A failed execution will be retried up to 7 days with an exponential
+// backoff
+// (capped at 10 seconds).
+// Retried execution is charged as any other execution.
+type Retry struct {
+}
+
// SourceRepository: Describes the location of the function source in a
// remote repository.
type SourceRepository struct {
diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json
index e1023be..7f4b3b2 100644
--- a/cloudkms/v1/cloudkms-api.json
+++ b/cloudkms/v1/cloudkms-api.json
@@ -2,6 +2,157 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "AuditConfig": {
+ "properties": {
+ "exemptedMembers": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuditConfig",
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object"
+ },
+ "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": {
+ "format": "google-datetime",
+ "description": "Output only. The time at which this CryptoKeyVersion was created.",
+ "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": {
+ "format": "google-datetime",
+ "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
+ "type": "string"
+ },
+ "destroyTime": {
+ "format": "google-datetime",
+ "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
+ "type": "string"
+ }
+ },
+ "id": "CryptoKeyVersion"
+ },
+ "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"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ },
+ "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"
+ },
+ "Expr": {
+ "properties": {
+ "location": {
+ "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
+ "type": "string"
+ },
+ "title": {
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
+ "type": "string"
+ }
+ },
+ "id": "Expr",
+ "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"
+ },
+ "EncryptRequest": {
+ "description": "Request message for KeyManagementService.Encrypt.",
+ "type": "object",
+ "properties": {
+ "additionalAuthenticatedData": {
+ "format": "byte",
+ "description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.",
+ "type": "string"
+ },
+ "plaintext": {
+ "format": "byte",
+ "description": "Required. The data to encrypt. Must be no larger than 64KiB.",
+ "type": "string"
+ }
+ },
+ "id": "EncryptRequest"
+ },
"ListCryptoKeyVersionsResponse": {
"description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
"type": "object",
@@ -40,12 +191,14 @@
"type": "object"
},
"DestroyCryptoKeyVersionRequest": {
- "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
- "type": "object",
"properties": {},
- "id": "DestroyCryptoKeyVersionRequest"
+ "id": "DestroyCryptoKeyVersionRequest",
+ "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
+ "type": "object"
},
"CryptoKey": {
+ "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
+ "type": "object",
"properties": {
"purpose": {
"enum": [
@@ -83,25 +236,12 @@
"type": "string"
}
},
- "id": "CryptoKey",
- "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
- "type": "object"
+ "id": "CryptoKey"
},
"Rule": {
"description": "A rule to be applied in a Policy.",
"type": "object",
"properties": {
- "description": {
- "description": "Human-readable description of the rule.",
- "type": "string"
- },
- "conditions": {
- "description": "Additional restrictions that must be met",
- "items": {
- "$ref": "Condition"
- },
- "type": "array"
- },
"logConfig": {
"description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
"items": {
@@ -149,6 +289,17 @@
"type": "string"
},
"type": "array"
+ },
+ "description": {
+ "description": "Human-readable description of the rule.",
+ "type": "string"
+ },
+ "conditions": {
+ "description": "Additional restrictions that must be met",
+ "items": {
+ "$ref": "Condition"
+ },
+ "type": "array"
}
},
"id": "Rule"
@@ -157,10 +308,6 @@
"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"
@@ -168,29 +315,31 @@
"dataAccess": {
"$ref": "DataAccessOptions",
"description": "Data access options."
+ },
+ "cloudAudit": {
+ "description": "Cloud audit options.",
+ "$ref": "CloudAuditOptions"
}
},
"id": "LogConfig"
},
"SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
"properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- },
"updateMask": {
"format": "google-fieldmask",
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"type": "string"
+ },
+ "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"
},
"DecryptRequest": {
- "description": "Request message for KeyManagementService.Decrypt.",
- "type": "object",
"properties": {
"additionalAuthenticatedData": {
"format": "byte",
@@ -203,12 +352,21 @@
"type": "string"
}
},
- "id": "DecryptRequest"
+ "id": "DecryptRequest",
+ "description": "Request message for KeyManagementService.Decrypt.",
+ "type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
+ },
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
@@ -224,20 +382,11 @@
},
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
}
},
"id": "Location"
},
"ListCryptoKeysResponse": {
- "description": "Response message for KeyManagementService.ListCryptoKeys.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeysRequest.page_token to retrieve the next page of results.",
@@ -256,10 +405,65 @@
"type": "array"
}
},
- "id": "ListCryptoKeysResponse"
+ "id": "ListCryptoKeysResponse",
+ "description": "Response message for KeyManagementService.ListCryptoKeys.",
+ "type": "object"
},
"Condition": {
"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).",
+ "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'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "value": {
+ "description": "DEPRECATED. Use 'values' instead.",
+ "type": "string"
+ },
"sys": {
"enumDescriptions": [
"Default non-attribute type",
@@ -277,59 +481,6 @@
],
"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"
- },
- "iam": {
- "enum": [
- "NO_ATTR",
- "AUTHORITY",
- "ATTRIBUTION",
- "APPROVER",
- "JUSTIFICATION_TYPE"
- ],
- "description": "Trusted attributes supplied by the IAM system.",
- "type": "string",
- "enumDescriptions": [
- "Default non-attribute.",
- "Either principal or (if present) authority selector.",
- "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
- "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).",
- "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."
- ]
- },
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "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"
}
},
"id": "Condition",
@@ -337,6 +488,8 @@
"type": "object"
},
"CounterOptions": {
+ "description": "Increment a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
+ "type": "object",
"properties": {
"field": {
"description": "The field value to attribute.",
@@ -347,9 +500,7 @@
"type": "string"
}
},
- "id": "CounterOptions",
- "description": "Increment a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
- "type": "object"
+ "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.",
@@ -363,6 +514,12 @@
"type": "array"
},
"logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
@@ -370,13 +527,7 @@
"DATA_READ"
],
"description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ]
+ "type": "string"
}
},
"id": "AuditLogConfig"
@@ -394,6 +545,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).",
@@ -403,11 +556,43 @@
"type": "array"
}
},
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest"
+ },
+ "KeyRing": {
+ "properties": {
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Output only. The time at which this KeyRing was created.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
+ "type": "string"
+ }
+ },
+ "id": "KeyRing",
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "type": "object"
+ },
+ "EncryptResponse": {
+ "properties": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "type": "string"
+ },
+ "ciphertext": {
+ "format": "byte",
+ "description": "The encrypted data.",
+ "type": "string"
+ }
+ },
+ "id": "EncryptResponse",
+ "description": "Response message for KeyManagementService.Encrypt.",
"type": "object"
},
"ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -421,11 +606,11 @@
"type": "array"
}
},
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
+ "id": "ListLocationsResponse"
},
"Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
"properties": {
"etag": {
"format": "byte",
@@ -462,62 +647,26 @@
"type": "array"
}
},
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object"
- },
- "EncryptResponse": {
- "properties": {
- "name": {
- "description": "The resource name of the CryptoKeyVersion used in encryption.",
- "type": "string"
- },
- "ciphertext": {
- "format": "byte",
- "description": "The encrypted data.",
- "type": "string"
- }
- },
- "id": "EncryptResponse",
- "description": "Response message for KeyManagementService.Encrypt.",
- "type": "object"
- },
- "KeyRing": {
- "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
- "type": "string"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Output only. The time at which this KeyRing was created.",
- "type": "string"
- }
- },
- "id": "KeyRing"
+ "id": "Policy"
},
"UpdateCryptoKeyPrimaryVersionRequest": {
- "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
- "type": "object",
"properties": {
"cryptoKeyVersionId": {
"description": "The id of the child CryptoKeyVersion to use as primary.",
"type": "string"
}
},
- "id": "UpdateCryptoKeyPrimaryVersionRequest"
- },
- "RestoreCryptoKeyVersionRequest": {
- "properties": {},
- "id": "RestoreCryptoKeyVersionRequest",
- "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
+ "id": "UpdateCryptoKeyPrimaryVersionRequest",
+ "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
"type": "object"
},
- "DataAccessOptions": {
- "description": "Write a Data Access (Gin) log",
+ "RestoreCryptoKeyVersionRequest": {
+ "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
"type": "object",
+ "properties": {},
+ "id": "RestoreCryptoKeyVersionRequest"
+ },
+ "DataAccessOptions": {
"properties": {
"logMode": {
"enumDescriptions": [
@@ -532,7 +681,9 @@
"type": "string"
}
},
- "id": "DataAccessOptions"
+ "id": "DataAccessOptions",
+ "description": "Write a Data Access (Gin) log",
+ "type": "object"
},
"ListKeyRingsResponse": {
"description": "Response message for KeyManagementService.ListKeyRings.",
@@ -556,164 +707,13 @@
}
},
"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": {
- "exemptedMembers": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "items": {
- "$ref": "AuditLogConfig"
- },
- "type": "array"
- }
- },
- "id": "AuditConfig"
- },
- "CryptoKeyVersion": {
- "description": "A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.",
- "type": "object",
- "properties": {
- "destroyTime": {
- "format": "google-datetime",
- "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
- "type": "string"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Output only. The time at which this CryptoKeyVersion was created.",
- "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"
- },
- "destroyEventTime": {
- "format": "google-datetime",
- "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
- "type": "string"
- }
- },
- "id": "CryptoKeyVersion"
- },
- "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"
- },
- "Binding": {
- "properties": {
- "condition": {
- "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.",
- "$ref": "Expr"
- },
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
- },
- "Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
- "properties": {
- "description": {
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "expression": {
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
- "type": "string"
- },
- "location": {
- "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
- "type": "string"
- },
- "title": {
- "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
- "type": "string"
- }
- },
- "id": "Expr"
- },
- "EncryptRequest": {
- "description": "Request message for KeyManagementService.Encrypt.",
- "type": "object",
- "properties": {
- "plaintext": {
- "format": "byte",
- "description": "Required. The data to encrypt. Must be no larger than 64KiB.",
- "type": "string"
- },
- "additionalAuthenticatedData": {
- "format": "byte",
- "description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.",
- "type": "string"
- }
- },
- "id": "EncryptRequest"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Cloud KMS",
"auth": {
"oauth2": {
@@ -736,28 +736,28 @@
"locations": {
"methods": {
"get": {
- "httpMethod": "GET",
"response": {
"$ref": "Location"
},
"parameterOrder": [
"name"
],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "Resource name for the location.",
- "type": "string",
- "required": true
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Resource name for the location.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "path": "v1/{+name}",
"id": "cloudkms.projects.locations.get",
+ "path": "v1/{+name}",
"description": "Get information about a location."
},
"list": {
@@ -768,6 +768,9 @@
"name"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"filter": {
"location": "query",
@@ -775,9 +778,9 @@
"type": "string"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
@@ -787,15 +790,12 @@
"location": "path"
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "The standard list page size.",
- "type": "integer",
- "location": "query"
+ "type": "integer"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectsId}/locations",
"id": "cloudkms.projects.locations.list",
"path": "v1/{+name}/locations",
@@ -805,34 +805,6 @@
"resources": {
"keyRings": {
"methods": {
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.testIamPermissions"
- },
"list": {
"description": "Lists KeyRings.",
"response": {
@@ -842,41 +814,73 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "parent": {
- "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
"pageToken": {
"description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
"type": "string",
"location": "query"
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
+ "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"
},
- "create": {
+ "setIamPolicy": {
"httpMethod": "POST",
"parameterOrder": [
- "parent"
+ "resource"
],
"response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/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",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "create": {
+ "description": "Create a new KeyRing in a given Project and Location.",
+ "request": {
+ "$ref": "KeyRing"
+ },
+ "response": {
"$ref": "KeyRing"
},
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
@@ -886,65 +890,34 @@
"required": true
},
"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",
- "location": "query"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
- "path": "v1/{+parent}/keyRings",
"id": "cloudkms.projects.locations.keyRings.create",
- "description": "Create a new KeyRing in a given Project and Location.",
- "request": {
- "$ref": "KeyRing"
- }
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
+ "path": "v1/{+parent}/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.",
"httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
"parameterOrder": [
"resource"
],
+ "response": {
+ "$ref": "Policy"
+ },
"parameters": {
"resource": {
+ "location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
}
},
"scopes": [
@@ -952,10 +925,12 @@
],
"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."
+ "id": "cloudkms.projects.locations.keyRings.getIamPolicy"
},
"get": {
+ "id": "cloudkms.projects.locations.keyRings.get",
+ "path": "v1/{+name}",
+ "description": "Returns metadata for a given KeyRing.",
"response": {
"$ref": "KeyRing"
},
@@ -975,385 +950,49 @@
"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."
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions"
}
},
"resources": {
"cryptoKeys": {
- "resources": {
- "cryptoKeyVersions": {
- "methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "parent": {
- "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
- "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
- "request": {
- "$ref": "CryptoKeyVersion"
- }
- },
- "destroy": {
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path",
- "description": "The resource name of the CryptoKeyVersion to destroy.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
- "path": "v1/{+name}:destroy",
- "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."
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path",
- "description": "The resource name of the CryptoKeyVersion to restore.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The name of the CryptoKeyVersion to get.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
- "description": "Returns metadata for a given CryptoKeyVersion."
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Required list of fields to be updated in this request.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path",
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
- "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.",
- "request": {
- "$ref": "CryptoKeyVersion"
- }
- },
- "list": {
- "response": {
- "$ref": "ListCryptoKeyVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "description": "Lists CryptoKeyVersions."
- }
- }
- }
- },
"methods": {
- "updatePrimaryVersion": {
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the CryptoKey to update.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
- "path": "v1/{+name}:updatePrimaryVersion",
- "request": {
- "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
- },
- "description": "Update the version of a CryptoKey that will be used in Encrypt"
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
- "path": "v1/{+name}",
- "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "The name of the CryptoKey to get.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}"
- },
- "patch": {
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Required list of fields to be updated in this request.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "type": "string",
- "required": true
- }
- },
- "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}",
- "description": "Update a CryptoKey.",
- "request": {
- "$ref": "CryptoKey"
- }
- },
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions"
- },
- "decrypt": {
- "description": "Decrypts data that was protected by Encrypt.",
- "request": {
- "$ref": "DecryptRequest"
- },
- "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.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
- "path": "v1/{+name}:decrypt"
- },
"list": {
- "description": "Lists CryptoKeys.",
- "httpMethod": "GET",
"response": {
"$ref": "ListCryptoKeysResponse"
},
"parameterOrder": [
"parent"
],
+ "httpMethod": "GET",
"parameters": {
- "parent": {
- "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- },
"pageToken": {
"location": "query",
"description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
@@ -1364,56 +1003,125 @@
"description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
"type": "integer",
"location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "path": "v1/{+parent}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list"
- },
- "encrypt": {
- "response": {
- "$ref": "EncryptResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
+ },
+ "parent": {
+ "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
- "path": "v1/{+name}:encrypt",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
+ "path": "v1/{+parent}/cryptoKeys",
+ "description": "Lists CryptoKeys."
+ },
+ "encrypt": {
"description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
"request": {
"$ref": "EncryptRequest"
- }
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "EncryptResponse"
+ },
+ "parameters": {
+ "name": {
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
+ "path": "v1/{+name}:encrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt"
+ },
+ "create": {
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "cryptoKeyId": {
+ "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
+ "path": "v1/{+parent}/cryptoKeys"
},
"setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Policy"
+ },
"parameters": {
"resource": {
+ "location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "updatePrimaryVersion": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameters": {
+ "name": {
+ "description": "The resource name of the CryptoKey to update.",
+ "type": "string",
+ "required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
@@ -1421,46 +1129,338 @@
"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",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
+ "path": "v1/{+name}:updatePrimaryVersion",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
+ "description": "Update the version of a CryptoKey that will be used in Encrypt",
"request": {
- "$ref": "SetIamPolicyRequest"
+ "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
}
},
- "create": {
- "path": "v1/{+parent}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
- "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
+ },
+ "get": {
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the CryptoKey to get.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
+ "path": "v1/{+name}",
+ "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion."
+ },
+ "patch": {
"request": {
"$ref": "CryptoKey"
},
- "httpMethod": "POST",
+ "description": "Update a CryptoKey.",
+ "httpMethod": "PATCH",
"parameterOrder": [
- "parent"
+ "name"
],
"response": {
"$ref": "CryptoKey"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "cryptoKeyId": {
+ "updateMask": {
"location": "query",
- "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "format": "google-fieldmask",
+ "description": "Required list of fields to be updated in this request.",
"type": "string"
},
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
- "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
}
},
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch"
+ },
+ "testIamPermissions": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ }
+ }
+ },
+ "decrypt": {
+ "request": {
+ "$ref": "DecryptRequest"
+ },
+ "description": "Decrypts data that was protected by Encrypt.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "DecryptResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys"
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
+ "path": "v1/{+name}:decrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt"
+ }
+ },
+ "resources": {
+ "cryptoKeyVersions": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListCryptoKeyVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "description": "Lists CryptoKeyVersions."
+ },
+ "create": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED."
+ },
+ "destroy": {
+ "request": {
+ "$ref": "DestroyCryptoKeyVersionRequest"
+ },
+ "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the CryptoKeyVersion to destroy.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ "path": "v1/{+name}:destroy"
+ },
+ "restore": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion to restore.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
+ "path": "v1/{+name}:restore",
+ "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
+ "request": {
+ "$ref": "RestoreCryptoKeyVersionRequest"
+ }
+ },
+ "patch": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required list of fields to be updated in this request.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path",
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "get": {
+ "description": "Returns metadata for a given CryptoKeyVersion.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the CryptoKeyVersion to get.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get"
+ }
+ }
}
}
}
@@ -1478,25 +1478,25 @@
"type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"location": "query",
@@ -1514,11 +1514,6 @@
"type": "string",
"location": "query"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
"enum": [
"1",
@@ -1532,31 +1527,36 @@
],
"location": "query"
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
+ "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"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
}
},
"version": "v1",
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-api.json b/cloudresourcemanager/v1/cloudresourcemanager-api.json
index 794dd79..4a2c0f8 100644
--- a/cloudresourcemanager/v1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -1,117 +1,10 @@
{
- "revision": "20170821",
"documentationLink": "https://cloud.google.com/resource-manager",
+ "revision": "20170821",
"id": "cloudresourcemanager:v1",
"discoveryVersion": "v1",
"schemas": {
- "ListAvailableOrgPolicyConstraintsRequest": {
- "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
- "type": "object",
- "properties": {
- "pageSize": {
- "format": "int32",
- "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
- "type": "integer"
- },
- "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"
- }
- },
- "id": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
- "properties": {
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "items": {
- "$ref": "AuditConfig"
- },
- "type": "array"
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "items": {
- "$ref": "Binding"
- },
- "type": "array"
- },
- "etag": {
- "format": "byte",
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- }
- },
- "id": "Policy"
- },
- "FolderOperation": {
- "description": "Metadata describing a long running folder operation",
- "type": "object",
- "properties": {
- "operationType": {
- "description": "The type of this operation.",
- "type": "string",
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ]
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
- }
- },
- "id": "FolderOperation"
- },
- "ResourceId": {
- "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
- "type": "string"
- },
- "id": {
- "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
- "type": "string"
- }
- },
- "id": "ResourceId"
- },
- "GetEffectiveOrgPolicyRequest": {
- "description": "The request sent to the GetEffectiveOrgPolicy method.",
- "type": "object",
- "properties": {
- "constraint": {
- "description": "The name of the `Constraint` to compute the effective `Policy`.",
- "type": "string"
- }
- },
- "id": "GetEffectiveOrgPolicyRequest"
- },
"ListOrgPoliciesRequest": {
- "description": "The request sent to the ListOrgPolicies method.",
"type": "object",
"properties": {
"pageSize": {
@@ -124,7 +17,43 @@
"type": "string"
}
},
- "id": "ListOrgPoliciesRequest"
+ "id": "ListOrgPoliciesRequest",
+ "description": "The request sent to the ListOrgPolicies method."
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ }
+ },
+ "id": "Operation"
},
"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.",
@@ -144,63 +73,37 @@
},
"id": "AuditConfig"
},
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "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": {
- "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"
- }
- },
- "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`.",
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
+ },
+ "details": {
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array",
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
}
},
- "id": "Operation"
+ "id": "Status"
},
"Constraint": {
"description": "A `Constraint` describes a way in which a resource's configuration can be\nrestricted. For example, it controls which cloud services can be activated\nacross an organization, or whether a Compute Engine instance can have\nserial port connections established. `Constraints` can be configured by the\norganization's policy adminstrator to fit the needs of the organzation by\nsetting Policies for `Constraints` at different locations in the\norganization's resource hierarchy. Policies are inherited down the resource\nhierarchy from higher levels, but can also be overridden. For details about\nthe inheritance rules please read about\nPolicies.\n\n`Constraints` have a default behavior determined by the `constraint_default`\nfield, which is the enforcement behavior that is used in the absence of a\n`Policy` being defined or inherited for the resource in question.",
"type": "object",
"properties": {
- "constraintDefault": {
- "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."
@@ -219,56 +122,47 @@
"type": "string"
},
"booleanConstraint": {
- "$ref": "BooleanConstraint",
- "description": "Defines this constraint as being a BooleanConstraint."
+ "description": "Defines this constraint as being a BooleanConstraint.",
+ "$ref": "BooleanConstraint"
+ },
+ "constraintDefault": {
+ "description": "The evaluation behavior of this constraint in the absense of 'Policy'.",
+ "type": "string",
+ "enumDescriptions": [
+ "This is only used for distinguishing unset values and should never be\nused.",
+ "Indicate that all values are allowed for list constraints.\nIndicate that enforcement is off for boolean constraints.",
+ "Indicate that all values are denied for list constraints.\nIndicate that enforcement is on for boolean constraints."
+ ],
+ "enum": [
+ "CONSTRAINT_DEFAULT_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ]
+ },
+ "name": {
+ "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
+ "type": "string"
}
},
"id": "Constraint"
},
"ListLiensResponse": {
+ "id": "ListLiensResponse",
"description": "The response message for Liens.ListLiens.",
"type": "object",
"properties": {
- "liens": {
- "description": "A list of Liens.",
- "items": {
- "$ref": "Lien"
- },
- "type": "array"
- },
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
"type": "string"
- }
- },
- "id": "ListLiensResponse"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
},
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "liens": {
"items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
+ "$ref": "Lien"
},
- "type": "array"
+ "type": "array",
+ "description": "A list of Liens."
}
- },
- "id": "Status"
+ }
},
"Binding": {
"description": "Associates `members` with a `role`.",
@@ -289,40 +183,40 @@
"id": "Binding"
},
"RestoreDefault": {
+ "id": "RestoreDefault",
"description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.",
"type": "object",
- "properties": {},
- "id": "RestoreDefault"
+ "properties": {}
},
"GetOrgPolicyRequest": {
"description": "The request sent to the GetOrgPolicy method.",
"type": "object",
"properties": {
"constraint": {
- "description": "Name of the `Constraint` to get the `Policy`.",
- "type": "string"
+ "type": "string",
+ "description": "Name of the `Constraint` to get the `Policy`."
}
},
"id": "GetOrgPolicyRequest"
},
"UndeleteProjectRequest": {
+ "id": "UndeleteProjectRequest",
"description": "The request sent to the UndeleteProject\nmethod.",
"type": "object",
- "properties": {},
- "id": "UndeleteProjectRequest"
+ "properties": {}
},
"ClearOrgPolicyRequest": {
"description": "The request sent to the ClearOrgPolicy method.",
"type": "object",
"properties": {
- "constraint": {
- "description": "Name of the `Constraint` of the `Policy` to clear.",
- "type": "string"
- },
"etag": {
"format": "byte",
"description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.",
"type": "string"
+ },
+ "constraint": {
+ "description": "Name of the `Constraint` of the `Policy` to clear.",
+ "type": "string"
}
},
"id": "ClearOrgPolicyRequest"
@@ -348,10 +242,10 @@
"id": "ProjectCreationStatus"
},
"BooleanConstraint": {
- "description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.",
- "type": "object",
"properties": {},
- "id": "BooleanConstraint"
+ "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": {
"description": "Request message for `GetIamPolicy` method.",
@@ -364,11 +258,11 @@
"type": "object",
"properties": {
"permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
}
},
"id": "TestIamPermissionsResponse"
@@ -388,16 +282,16 @@
"description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime."
+ },
"projects": {
"description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
"items": {
"$ref": "Project"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
- "type": "string"
}
},
"id": "ListProjectsResponse"
@@ -406,7 +300,21 @@
"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": {
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED",
+ "DELETE_IN_PROGRESS"
+ ],
"description": "The Project lifecycle state.\n\nRead-only.",
"type": "string",
"enumDescriptions": [
@@ -414,12 +322,6 @@
"The normal and active state.",
"The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
"This lifecycle state is no longer used and not returned by the API."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
]
},
"projectNumber": {
@@ -442,14 +344,6 @@
"format": "google-datetime",
"description": "Creation time.\n\nRead-only.",
"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"
@@ -491,10 +385,10 @@
"id": "ListOrgPoliciesResponse"
},
"FolderOperationError": {
- "description": "A classification of the Folder Operation error.",
- "type": "object",
"properties": {
"errorMessageId": {
+ "description": "The type of operation error experienced.",
+ "type": "string",
"enumDescriptions": [
"The error type was unrecognized or unspecified.",
"The attempted action would violate the max folder depth constraint.",
@@ -518,36 +412,45 @@
"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"
},
"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"
+ "type": "boolean",
+ "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`."
}
},
- "id": "BooleanPolicy"
+ "id": "BooleanPolicy",
+ "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
+ "type": "object"
},
"OrgPolicy": {
"description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
"type": "object",
"properties": {
- "booleanPolicy": {
- "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not.",
- "$ref": "BooleanPolicy"
+ "listPolicy": {
+ "$ref": "ListPolicy",
+ "description": "List of values either allowed or disallowed."
+ },
+ "etag": {
+ "format": "byte",
+ "description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
+ "type": "string"
},
"constraint": {
"description": "The name of the `Constraint` the `Policy` is configuring, for example,\n`constraints/serviceuser.services`.\n\nImmutable after creation.",
"type": "string"
},
+ "booleanPolicy": {
+ "$ref": "BooleanPolicy",
+ "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not."
+ },
"updateTime": {
"format": "google-datetime",
"description": "The time stamp the `Policy` was previously updated. This is set by the\nserver, not specified by the caller, and represents the last time a call to\n`SetOrgPolicy` was made for that `Policy`. Any value set by the client will\nbe ignored.",
@@ -561,15 +464,6 @@
"restoreDefault": {
"description": "Restores the default behavior of the constraint; independent of\n`Constraint` type.",
"$ref": "RestoreDefault"
- },
- "listPolicy": {
- "$ref": "ListPolicy",
- "description": "List of values either allowed or disallowed."
- },
- "etag": {
- "format": "byte",
- "description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
- "type": "string"
}
},
"id": "OrgPolicy"
@@ -578,6 +472,10 @@
"description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.",
"type": "object",
"properties": {
+ "parent": {
+ "description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`",
+ "type": "string"
+ },
"createTime": {
"format": "google-datetime",
"description": "The creation time of this Lien.",
@@ -601,15 +499,12 @@
"type": "string"
},
"type": "array"
- },
- "parent": {
- "description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`",
- "type": "string"
}
},
"id": "Lien"
},
"Ancestor": {
+ "id": "Ancestor",
"description": "Identifying information for a single ancestor of a project.",
"type": "object",
"properties": {
@@ -617,8 +512,7 @@
"description": "Resource id of the ancestor.",
"$ref": "ResourceId"
}
- },
- "id": "Ancestor"
+ }
},
"ListConstraint": {
"description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`.",
@@ -643,20 +537,20 @@
"id": "SetOrgPolicyRequest"
},
"SetIamPolicyRequest": {
+ "id": "SetIamPolicyRequest",
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
"updateMask": {
"format": "google-fieldmask",
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"type": "string"
- },
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
}
- },
- "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 `{}`.",
@@ -668,6 +562,15 @@
"description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
"type": "object",
"properties": {
+ "displayName": {
+ "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
+ "type": "string"
+ },
+ "creationTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "type": "string"
+ },
"lifecycleState": {
"enumDescriptions": [
"Unspecified state. This is only useful for distinguishing unset values.",
@@ -683,21 +586,12 @@
"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."
+ "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"
- },
- "displayName": {
- "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
- "type": "string"
- },
- "creationTime": {
- "format": "google-datetime",
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
- "type": "string"
}
},
"id": "Organization"
@@ -721,6 +615,7 @@
"id": "ListAvailableOrgPolicyConstraintsResponse"
},
"ListPolicy": {
+ "id": "ListPolicy",
"description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset.",
"type": "object",
"properties": {
@@ -736,8 +631,8 @@
"type": "boolean"
},
"suggestedValue": {
- "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`.",
- "type": "string"
+ "type": "string",
+ "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`."
},
"deniedValues": {
"description": "List of values denied at this resource. Can only be set if no values are\nset for `allowed_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
@@ -747,8 +642,6 @@
"type": "array"
},
"allValues": {
- "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.",
@@ -758,12 +651,14 @@
"ALL_VALUES_UNSPECIFIED",
"ALLOW",
"DENY"
- ]
+ ],
+ "description": "The policy all_values state.",
+ "type": "string"
}
- },
- "id": "ListPolicy"
+ }
},
"GetAncestryResponse": {
+ "id": "GetAncestryResponse",
"description": "Response from the GetAncestry method.",
"type": "object",
"properties": {
@@ -774,14 +669,17 @@
},
"type": "array"
}
- },
- "id": "GetAncestryResponse"
+ }
},
"AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
"properties": {
"logType": {
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
"description": "The log type that this config enables.",
"type": "string",
"enumDescriptions": [
@@ -789,32 +687,22 @@
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
]
},
"exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members."
}
},
- "id": "AuditLogConfig"
+ "id": "AuditLogConfig",
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object"
},
"SearchOrganizationsRequest": {
- "description": "The request sent to the `SearchOrganizations` method.",
- "type": "object",
"properties": {
- "filter": {
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string"
- },
"pageToken": {
"description": "A pagination token returned from a previous call to `SearchOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
"type": "string"
@@ -823,9 +711,15 @@
"format": "int32",
"description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
"type": "integer"
+ },
+ "filter": {
+ "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ "type": "string"
}
},
- "id": "SearchOrganizationsRequest"
+ "id": "SearchOrganizationsRequest",
+ "description": "The request sent to the `SearchOrganizations` method.",
+ "type": "object"
},
"GetAncestryRequest": {
"description": "The request sent to the\nGetAncestry\nmethod.",
@@ -846,13 +740,119 @@
}
},
"id": "TestIamPermissionsRequest"
+ },
+ "ListAvailableOrgPolicyConstraintsRequest": {
+ "id": "ListAvailableOrgPolicyConstraintsRequest",
+ "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
+ "type": "integer"
+ }
+ }
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "type": "integer"
+ },
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "AuditConfig"
+ },
+ "type": "array"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "format": "byte",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "type": "string"
+ }
+ },
+ "id": "Policy"
+ },
+ "FolderOperation": {
+ "type": "object",
+ "properties": {
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ },
+ "operationType": {
+ "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"
+ }
+ },
+ "id": "FolderOperation",
+ "description": "Metadata describing a long running folder operation"
+ },
+ "ResourceId": {
+ "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\""
+ },
+ "id": {
+ "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
+ "type": "string"
+ }
+ },
+ "id": "ResourceId"
+ },
+ "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"
}
},
- "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 Resource Manager",
"auth": {
"oauth2": {
@@ -874,173 +874,13 @@
"title": "Google Cloud Resource Manager API",
"ownerName": "Google",
"resources": {
- "organizations": {
+ "folders": {
"methods": {
- "getOrgPolicy": {
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource the `Policy` is set on.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy",
- "id": "cloudresourcemanager.organizations.getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "request": {
- "$ref": "GetOrgPolicyRequest"
- },
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write."
- },
- "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.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
- "request": {
- "$ref": "SearchOrganizationsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchOrganizationsResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations:search",
- "path": "v1/organizations:search",
- "id": "cloudresourcemanager.organizations.search"
- },
- "get": {
- "description": "Fetches an Organization resource identified by the specified resource name.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Organization"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.organizations.get"
- },
- "getEffectiveOrgPolicy": {
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "description": "The name of the resource to start computing the effective `Policy`.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy"
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".\n\nThere are no permissions required for making this API call.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions"
- },
- "clearOrgPolicy": {
- "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.organizations.clearOrgPolicy",
- "description": "Clears a `Policy` from a resource.",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "resource": {
- "description": "Name of the resource for the `Policy` to clear.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
"setOrgPolicy": {
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
"request": {
"$ref": "SetOrgPolicyRequest"
},
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
"response": {
"$ref": "OrgPolicy"
},
@@ -1048,55 +888,23 @@
"resource"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"resource": {
+ "pattern": "^folders/[^/]+$",
"location": "path",
"description": "Resource name of the resource to attach the `Policy`.",
"type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
+ "required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
- "id": "cloudresourcemanager.organizations.setOrgPolicy",
+ "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
+ "id": "cloudresourcemanager.folders.setOrgPolicy",
"path": "v1/{+resource}:setOrgPolicy"
},
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization"
- },
"listAvailableOrgPolicyConstraints": {
- "description": "Lists `Constraints` that could be applied on the specified resource.",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
"response": {
"$ref": "ListAvailableOrgPolicyConstraintsResponse"
},
@@ -1104,28 +912,32 @@
"resource"
],
"httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource to list `Constraints` for.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints"
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource to list `Constraints` for.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "description": "Lists `Constraints` that could be applied on the specified resource."
},
"listOrgPolicies": {
- "description": "Lists all the `Policies` set for a particular resource.",
"request": {
"$ref": "ListOrgPoliciesRequest"
},
+ "description": "Lists all the `Policies` set for a particular resource.",
"response": {
"$ref": "ListOrgPoliciesResponse"
},
@@ -1133,184 +945,37 @@
"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.",
"type": "string",
"required": true,
- "pattern": "^organizations/[^/]+$",
+ "pattern": "^folders/[^/]+$",
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
- "id": "cloudresourcemanager.organizations.listOrgPolicies",
+ "flatPath": "v1/folders/{foldersId}:listOrgPolicies",
+ "id": "cloudresourcemanager.folders.listOrgPolicies",
"path": "v1/{+resource}:listOrgPolicies"
},
- "getIamPolicy": {
- "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy"
- }
- }
- },
- "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.",
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudresourcemanager.operations.get",
- "path": "v1/{+name}"
- }
- }
- },
- "liens": {
- "methods": {
- "delete": {
- "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name/identifier of the Lien to delete.",
- "type": "string",
- "required": true,
- "pattern": "^liens/.+$"
- }
- },
- "flatPath": "v1/liens/{liensId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.liens.delete"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListLiensResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "The `next_page_token` value returned from a previous List request, if any.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of items to return. This is a suggestion for the server.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/liens",
- "path": "v1/liens",
- "id": "cloudresourcemanager.liens.list",
- "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`."
- },
- "create": {
- "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"
- },
- "response": {
- "$ref": "Lien"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "folders": {
- "methods": {
"getOrgPolicy": {
+ "id": "cloudresourcemanager.folders.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"
},
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "OrgPolicy"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "parameterOrder": [
+ "resource"
],
+ "httpMethod": "POST",
"parameters": {
"resource": {
"description": "Name of the resource the `Policy` is set on.",
@@ -1320,15 +985,13 @@
"location": "path"
}
},
- "flatPath": "v1/folders/{foldersId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.folders.getOrgPolicy"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/folders/{foldersId}:getOrgPolicy"
},
"getEffectiveOrgPolicy": {
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
"response": {
"$ref": "OrgPolicy"
},
@@ -1351,7 +1014,11 @@
},
"flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
"id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy"
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ },
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources."
},
"clearOrgPolicy": {
"request": {
@@ -1370,163 +1037,22 @@
],
"parameters": {
"resource": {
- "description": "Name of the resource for the `Policy` to clear.",
"type": "string",
"required": true,
"pattern": "^folders/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "Name of the resource for the `Policy` to clear."
}
},
"flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
"id": "cloudresourcemanager.folders.clearOrgPolicy",
"path": "v1/{+resource}:clearOrgPolicy"
- },
- "setOrgPolicy": {
- "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.folders.setOrgPolicy",
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "listAvailableOrgPolicyConstraints": {
- "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"
- },
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "Name of the resource to list `Constraints` for.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "listOrgPolicies": {
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "description": "Lists all the `Policies` set for a particular resource.",
- "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": {
- "location": "path",
- "description": "Name of the resource to list Policies for.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- },
- "flatPath": "v1/folders/{foldersId}:listOrgPolicies",
- "id": "cloudresourcemanager.folders.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies"
}
}
},
"projects": {
"methods": {
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "v1/projects/{resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call."
- },
- "delete": {
- "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.delete",
- "path": "v1/projects/{projectId}"
- },
"clearOrgPolicy": {
- "flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
- "id": "cloudresourcemanager.projects.clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
"request": {
"$ref": "ClearOrgPolicyRequest"
},
@@ -1543,19 +1069,22 @@
],
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
"description": "Name of the resource for the `Policy` to clear.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "required": true
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
+ "id": "cloudresourcemanager.projects.clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy"
},
"setIamPolicy": {
+ "description": "Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project",
"request": {
"$ref": "SetIamPolicyRequest"
},
- "description": "Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project",
"response": {
"$ref": "Policy"
},
@@ -1563,51 +1092,55 @@
"resource"
],
"httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "required": true,
+ "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"
],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
"flatPath": "v1/projects/{resource}:setIamPolicy",
"id": "cloudresourcemanager.projects.setIamPolicy",
"path": "v1/projects/{resource}:setIamPolicy"
},
"listAvailableOrgPolicyConstraints": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
"response": {
"$ref": "ListAvailableOrgPolicyConstraintsResponse"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"resource": {
- "location": "path",
- "description": "Name of the resource to list `Constraints` for.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$"
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource to list `Constraints` for."
}
},
"flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
"id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "description": "Lists `Constraints` that could be applied on the specified resource."
+ "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.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project",
"response": {
"$ref": "Policy"
},
@@ -1629,42 +1162,42 @@
},
"flatPath": "v1/projects/{resource}:getIamPolicy",
"id": "cloudresourcemanager.projects.getIamPolicy",
- "path": "v1/projects/{resource}:getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project"
+ "path": "v1/projects/{resource}:getIamPolicy"
},
"getOrgPolicy": {
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
"request": {
"$ref": "GetOrgPolicyRequest"
},
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "OrgPolicy"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "parameterOrder": [
+ "resource"
],
+ "httpMethod": "POST",
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "Name of the resource the `Policy` is set on.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
+ "required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1/projects/{projectsId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.projects.getOrgPolicy"
+ "id": "cloudresourcemanager.projects.getOrgPolicy",
+ "path": "v1/{+resource}:getOrgPolicy"
},
"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"
},
@@ -1672,10 +1205,6 @@
"resource"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"resource": {
"description": "The name of the resource to start computing the effective `Policy`.",
@@ -1685,46 +1214,42 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
"id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources."
+ "path": "v1/{+resource}:getEffectiveOrgPolicy"
},
"undelete": {
- "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
- "request": {
- "$ref": "UndeleteProjectRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
"parameters": {
"projectId": {
- "location": "path",
"description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}:undelete",
+ "path": "v1/projects/{projectId}:undelete",
"id": "cloudresourcemanager.projects.undelete",
- "path": "v1/projects/{projectId}:undelete"
+ "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
+ "request": {
+ "$ref": "UndeleteProjectRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ }
},
"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"
},
@@ -1745,23 +1270,24 @@
],
"flatPath": "v1/projects/{projectId}",
"id": "cloudresourcemanager.projects.update",
- "path": "v1/projects/{projectId}"
+ "path": "v1/projects/{projectId}",
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
+ "request": {
+ "$ref": "Project"
+ }
},
"list": {
- "flatPath": "v1/projects",
- "id": "cloudresourcemanager.projects.list",
- "path": "v1/projects",
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nNew Projects do not necessarily appear at the end of the list.",
"response": {
"$ref": "ListProjectsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
+ "type": "string"
+ },
"pageSize": {
"location": "query",
"format": "int32",
@@ -1772,15 +1298,393 @@
"location": "query",
"description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
"type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
- "type": "string"
}
- }
+ },
+ "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": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
+ "id": "cloudresourcemanager.projects.setOrgPolicy",
+ "path": "v1/{+resource}:setOrgPolicy",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ },
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/projects",
+ "path": "v1/projects",
+ "id": "cloudresourcemanager.projects.create",
+ "request": {
+ "$ref": "Project"
+ },
+ "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject."
+ },
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:listOrgPolicies",
+ "id": "cloudresourcemanager.projects.listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "description": "Lists all the `Policies` set for a particular resource."
+ },
+ "get": {
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Project"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get"
+ },
+ "getAncestry": {
+ "flatPath": "v1/projects/{projectId}:getAncestry",
+ "id": "cloudresourcemanager.projects.getAncestry",
+ "path": "v1/projects/{projectId}:getAncestry",
+ "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "request": {
+ "$ref": "GetAncestryRequest"
+ },
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{resource}:testIamPermissions",
+ "path": "v1/projects/{resource}:testIamPermissions",
+ "id": "cloudresourcemanager.projects.testIamPermissions"
+ },
+ "delete": {
+ "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete"
+ }
+ }
+ },
+ "organizations": {
+ "methods": {
+ "getIamPolicy": {
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:getIamPolicy"
+ },
+ "search": {
+ "request": {
+ "$ref": "SearchOrganizationsRequest"
+ },
+ "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
+ "response": {
+ "$ref": "SearchOrganizationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {},
+ "flatPath": "v1/organizations:search",
+ "id": "cloudresourcemanager.organizations.search",
+ "path": "v1/organizations:search"
+ },
+ "getOrgPolicy": {
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource the `Policy` is set on.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getEffectiveOrgPolicy": {
+ "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ },
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "get": {
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}",
+ "id": "cloudresourcemanager.organizations.get",
+ "path": "v1/{+name}"
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}: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\".\n\nThere are no permissions required for making this API call."
+ },
+ "clearOrgPolicy": {
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "id": "cloudresourcemanager.organizations.clearOrgPolicy",
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "description": "Clears a `Policy` from a resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource for the `Policy` to clear.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy"
+ },
+ "setOrgPolicy": {
+ "id": "cloudresourcemanager.organizations.setOrgPolicy",
+ "path": "v1/{+resource}:setOrgPolicy",
"request": {
"$ref": "SetOrgPolicyRequest"
},
@@ -1800,37 +1704,45 @@
"description": "Resource name of the resource to attach the `Policy`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$",
+ "pattern": "^organizations/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
- "id": "cloudresourcemanager.projects.setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy"
+ "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy"
},
- "create": {
- "response": {
- "$ref": "Operation"
+ "setIamPolicy": {
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
},
- "parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "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.",
+ "type": "string",
+ "required": true
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "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.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject.",
- "request": {
- "$ref": "Project"
- }
+ "flatPath": "v1/organizations/{organizationsId}:setIamPolicy"
},
"listOrgPolicies": {
+ "description": "Lists all the `Policies` set for a particular resource.",
"request": {
"$ref": "ListOrgPoliciesRequest"
},
- "description": "Lists all the `Policies` set for a particular resource.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -1838,75 +1750,163 @@
"response": {
"$ref": "ListOrgPoliciesResponse"
},
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource to list Policies for."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "id": "cloudresourcemanager.organizations.listOrgPolicies"
+ },
+ "listAvailableOrgPolicyConstraints": {
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list `Constraints` for.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "cloudresourcemanager.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
+ "liens": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
"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.",
+ "name": {
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "pattern": "^liens/.+$",
+ "location": "path",
+ "description": "The name/identifier of the Lien to delete."
}
},
- "flatPath": "v1/projects/{projectsId}:listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "id": "cloudresourcemanager.projects.listOrgPolicies"
+ "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`."
},
- "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.",
+ "list": {
"response": {
- "$ref": "Project"
+ "$ref": "ListLiensResponse"
},
- "parameterOrder": [
- "projectId"
- ],
+ "parameterOrder": [],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true
+ "parent": {
+ "location": "query",
+ "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of items to return. This is a suggestion for the server.",
+ "type": "integer",
+ "location": "query"
}
},
- "flatPath": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get",
- "path": "v1/projects/{projectId}"
+ "flatPath": "v1/liens",
+ "id": "cloudresourcemanager.liens.list",
+ "path": "v1/liens",
+ "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`."
},
- "getAncestry": {
- "flatPath": "v1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "path": "v1/projects/{projectId}:getAncestry",
- "request": {
- "$ref": "GetAncestryRequest"
- },
- "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "create": {
"response": {
- "$ref": "GetAncestryResponse"
+ "$ref": "Lien"
},
- "parameterOrder": [
- "projectId"
- ],
+ "parameterOrder": [],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- }
+ "parameters": {},
+ "flatPath": "v1/liens",
+ "id": "cloudresourcemanager.liens.create",
+ "path": "v1/liens",
+ "request": {
+ "$ref": "Lien"
+ },
+ "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied."
}
}
}
@@ -1923,21 +1923,16 @@
"default": "true",
"type": "boolean"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
@@ -1951,7 +1946,18 @@
"2"
]
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -1959,13 +1965,7 @@
"media",
"proto"
],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
+ "type": "string"
},
"access_token": {
"location": "query",
@@ -1973,36 +1973,36 @@
"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"
},
- "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",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "boolean"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
}
},
"version": "v1",
"baseUrl": "https://cloudresourcemanager.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"servicePath": "",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "kind": "discovery#restDescription",
"basePath": ""
}
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
index dc71679..966b734 100644
--- a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,25 +1,609 @@
{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudresourcemanager",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Resource Manager API",
+ "ownerName": "Google",
+ "resources": {
+ "organizations": {
+ "methods": {
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\"."
+ },
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy",
+ "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"
+ }
+ },
+ "get": {
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameters": {
+ "organizationId": {
+ "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudresourcemanager.organizations.get"
+ },
+ "update": {
+ "request": {
+ "$ref": "Organization"
+ },
+ "description": "Updates an Organization resource identified by the specified resource name.",
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "id": "cloudresourcemanager.organizations.update",
+ "path": "v1beta1/{+name}"
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListOrganizationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional."
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/organizations",
+ "id": "cloudresourcemanager.organizations.list",
+ "path": "v1beta1/organizations",
+ "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."
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "getIamPolicy": {
+ "flatPath": "v1beta1/projects/{resource}:getIamPolicy",
+ "path": "v1beta1/projects/{resource}:getIamPolicy",
+ "id": "cloudresourcemanager.projects.getIamPolicy",
+ "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}",
+ "path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get"
+ },
+ "undelete": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The project ID (for example, `foo-bar-123`).\n\nRequired."
+ }
+ },
+ "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"
+ }
+ },
+ "getAncestry": {
+ "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "request": {
+ "$ref": "GetAncestryRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}:getAncestry",
+ "path": "v1beta1/projects/{projectId}:getAncestry",
+ "id": "cloudresourcemanager.projects.getAncestry"
+ },
+ "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.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}",
+ "path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update"
+ },
+ "testIamPermissions": {
+ "flatPath": "v1beta1/projects/{resource}:testIamPermissions",
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "path": "v1beta1/projects/{resource}:testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified Project.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "delete": {
+ "flatPath": "v1beta1/projects/{projectId}",
+ "path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete",
+ "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
+ "type": "string"
+ },
+ "pageToken": {
+ "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": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional."
+ }
+ },
+ "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.",
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": []
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
+ "path": "v1beta1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy"
+ },
+ "create": {
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "useLegacyStack": {
+ "location": "query",
+ "description": "A safety hatch to opt out of the new reliable project creation process.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v1beta1/projects",
+ "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."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ }
+ },
"version": "v1beta1",
"baseUrl": "https://cloudresourcemanager.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"servicePath": "",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "kind": "discovery#restDescription",
"basePath": "",
"id": "cloudresourcemanager:v1beta1",
- "revision": "20170821",
"documentationLink": "https://cloud.google.com/resource-manager",
+ "revision": "20170821",
"discoveryVersion": "v1",
"schemas": {
- "Ancestor": {
- "description": "Identifying information for a single ancestor of a project.",
+ "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": {
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array",
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4"
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "Ancestor": {
+ "properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "Resource id of the ancestor."
}
},
- "id": "Ancestor"
+ "id": "Ancestor",
+ "description": "Identifying information for a single ancestor of a project.",
+ "type": "object"
},
"SetIamPolicyRequest": {
"type": "object",
@@ -79,11 +663,25 @@
"properties": {},
"id": "Empty"
},
+ "UndeleteProjectRequest": {
+ "description": "The request sent to the UndeleteProject\nmethod.",
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteProjectRequest"
+ },
"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",
"properties": {
+ "displayName": {
+ "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
+ "type": "string"
+ },
+ "creationTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "type": "string"
+ },
"owner": {
"$ref": "OrganizationOwner",
"description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
@@ -109,31 +707,18 @@
"ACTIVE",
"DELETE_REQUESTED"
]
- },
- "displayName": {
- "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
- "type": "string"
- },
- "creationTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly"
}
- }
- },
- "UndeleteProjectRequest": {
- "description": "The request sent to the UndeleteProject\nmethod.",
- "type": "object",
- "properties": {},
- "id": "UndeleteProjectRequest"
+ },
+ "id": "Organization"
},
"ProjectCreationStatus": {
+ "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",
"properties": {
"ready": {
- "type": "boolean",
- "description": "True if the project creation process is complete."
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
},
"gettable": {
"type": "boolean",
@@ -144,11 +729,15 @@
"description": "Creation time of the project creation workflow.",
"type": "string"
}
- },
- "id": "ProjectCreationStatus"
+ }
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
},
"TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
@@ -159,13 +748,8 @@
"type": "array"
}
},
- "id": "TestIamPermissionsResponse"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method."
},
"OrganizationOwner": {
"description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
@@ -179,7 +763,6 @@
"id": "OrganizationOwner"
},
"GetAncestryResponse": {
- "description": "Response from the GetAncestry method.",
"type": "object",
"properties": {
"ancestor": {
@@ -190,28 +773,10 @@
"type": "array"
}
},
- "id": "GetAncestryResponse"
- },
- "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.",
- "items": {
- "$ref": "Project"
- },
- "type": "array"
- }
- },
- "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"
+ "id": "GetAncestryResponse",
+ "description": "Response from the GetAncestry method."
},
"AuditLogConfig": {
- "type": "object",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
@@ -221,12 +786,6 @@
"type": "array"
},
"logType": {
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
"description": "The log type that this config enables.",
"type": "string",
"enumDescriptions": [
@@ -234,41 +793,81 @@
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
]
}
},
"id": "AuditLogConfig",
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging."
+ "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"
+ },
+ "ListProjectsResponse": {
+ "properties": {
+ "projects": {
+ "items": {
+ "$ref": "Project"
+ },
+ "type": "array",
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated."
+ },
+ "nextPageToken": {
+ "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
+ "type": "string"
+ }
+ },
+ "id": "ListProjectsResponse",
+ "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
+ "type": "object"
},
"GetAncestryRequest": {
- "description": "The request sent to the\nGetAncestry\nmethod.",
"type": "object",
"properties": {},
- "id": "GetAncestryRequest"
+ "id": "GetAncestryRequest",
+ "description": "The request sent to the\nGetAncestry\nmethod."
},
"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": {
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Creation time.\n\nRead-only.",
+ "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": {
+ "type": "string",
+ "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."
+ },
"projectId": {
"description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
"type": "string"
},
"lifecycleState": {
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
- ],
- "description": "The Project lifecycle state.\n\nRead-only.",
"type": "string",
"enumDescriptions": [
"Unspecified state. This is only used/useful for distinguishing\nunset values.",
"The normal and active state.",
"The project has been marked for deletion by the user\n(by invoking 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."
},
"projectNumber": {
"format": "int64",
@@ -278,39 +877,24 @@
"parent": {
"$ref": "ResourceId",
"description": "An optional reference to a parent Resource.\n\nThe only supported parent type is \"organization\". Once set, the parent\ncannot be modified. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write."
- },
- "labels": {
- "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Creation time.\n\nRead-only.",
- "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"
}
},
- "id": "Project"
+ "id": "Project",
+ "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources."
},
"TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
- "type": "array",
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."
+ "type": "array"
}
- }
+ },
+ "id": "TestIamPermissionsRequest"
},
"FolderOperationError": {
"description": "A classification of the Folder Operation error.",
@@ -347,52 +931,11 @@
},
"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": {
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "items": {
- "$ref": "AuditConfig"
- },
- "type": "array"
- },
- "bindings": {
- "items": {
- "$ref": "Binding"
- },
- "type": "array",
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error."
- },
- "etag": {
- "format": "byte",
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- }
- },
- "id": "Policy"
- },
"FolderOperation": {
+ "id": "FolderOperation",
+ "description": "Metadata describing a long running folder operation",
"type": "object",
"properties": {
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "destinationParent": {
- "type": "string",
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to."
- },
"operationType": {
"enumDescriptions": [
"Operation type not specified.",
@@ -406,18 +949,59 @@
],
"description": "The type of this operation.",
"type": "string"
+ },
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
+ "destinationParent": {
+ "type": "string",
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to."
+ }
+ }
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "format": "byte",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "type": "string"
+ },
+ "version": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0."
+ },
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "AuditConfig"
+ },
+ "type": "array"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
}
},
- "id": "FolderOperation",
- "description": "Metadata describing a long running folder operation"
+ "id": "Policy"
},
"ResourceId": {
"description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
"type": "object",
"properties": {
"type": {
- "type": "string",
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\", \"folder\", and \"organization\"."
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\", \"folder\", and \"organization\".",
+ "type": "string"
},
"id": {
"description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
@@ -425,24 +1009,6 @@
}
},
"id": "ResourceId"
- },
- "AuditConfig": {
- "type": "object",
- "properties": {
- "service": {
- "type": "string",
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services."
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "items": {
- "$ref": "AuditLogConfig"
- },
- "type": "array"
- }
- },
- "id": "AuditConfig",
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging."
}
},
"icons": {
@@ -450,571 +1016,5 @@
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest",
- "canonicalName": "Cloud Resource Manager",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudresourcemanager.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudresourcemanager",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Resource Manager API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "create": {
- "request": {
- "$ref": "Project"
- },
- "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "useLegacyStack": {
- "description": "A safety hatch to opt out of the new reliable project creation process.",
- "type": "boolean",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/projects",
- "path": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.create"
- },
- "setIamPolicy": {
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "path": "v1beta1/projects/{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()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{resource}:setIamPolicy"
- },
- "getIamPolicy": {
- "id": "cloudresourcemanager.projects.getIamPolicy",
- "path": "v1beta1/projects/{resource}:getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{resource}:getIamPolicy"
- },
- "get": {
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}",
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get"
- },
- "undelete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete",
- "path": "v1beta1/projects/{projectId}:undelete",
- "request": {
- "$ref": "UndeleteProjectRequest"
- },
- "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project."
- },
- "update": {
- "flatPath": "v1beta1/projects/{projectId}",
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
- "request": {
- "$ref": "Project"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "getAncestry": {
- "request": {
- "$ref": "GetAncestryRequest"
- },
- "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "response": {
- "$ref": "GetAncestryResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "projectId": {
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "path": "v1beta1/projects/{projectId}:getAncestry"
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Project.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "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.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}",
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.delete"
- },
- "list": {
- "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.",
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
- "type": "integer"
- }
- }
- }
- }
- },
- "organizations": {
- "methods": {
- "update": {
- "request": {
- "$ref": "Organization"
- },
- "description": "Updates an Organization resource identified by the specified resource name.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Organization"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "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\"."
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "path": "v1beta1/{+name}",
- "id": "cloudresourcemanager.organizations.update"
- },
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOrganizationsResponse"
- },
- "parameterOrder": [],
- "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",
- "format": "int32",
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string"
- }
- },
- "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": {
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy"
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}: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"
- }
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Organization"
- },
- "parameters": {
- "organizationId": {
- "type": "string",
- "location": "query",
- "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead."
- },
- "name": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "path": "v1beta1/{+name}",
- "id": "cloudresourcemanager.organizations.get",
- "description": "Fetches an Organization resource identified by the specified resource name."
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "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": {
- "description": "Available to use 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"
- }
- }
+ "canonicalName": "Cloud Resource Manager"
}
diff --git a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
index 28a53d7..dc9d4b5 100644
--- a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
@@ -1,14 +1,63 @@
{
- "id": "cloudresourcemanager:v2beta1",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "revision": "20170821",
"discoveryVersion": "v1",
"schemas": {
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
+ "ProjectCreationStatus": {
"type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
+ "properties": {
+ "ready": {
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
+ },
+ "gettable": {
+ "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Creation time of the project creation workflow.",
+ "type": "string"
+ }
+ },
+ "id": "ProjectCreationStatus",
+ "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."
+ },
+ "Folder": {
+ "properties": {
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
+ "type": "string"
+ },
+ "lifecycleState": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified state.",
+ "The normal and active state.",
+ "The folder has been marked for deletion by the user."
+ ],
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED"
+ ],
+ "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\n[DeleteFolder] and [UndeleteFolder]."
+ },
+ "name": {
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.",
+ "type": "string"
+ },
+ "parent": {
+ "type": "string",
+ "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via [MoveFolders]."
+ }
+ },
+ "id": "Folder",
+ "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
+ "type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
@@ -24,6 +73,12 @@
},
"id": "TestIamPermissionsResponse"
},
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
"UndeleteFolderRequest": {
"description": "The UndeleteFolder request message.",
"type": "object",
@@ -61,8 +116,6 @@
"id": "AuditLogConfig"
},
"TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
@@ -72,25 +125,13 @@
"type": "array"
}
},
- "id": "TestIamPermissionsRequest"
+ "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",
"ACTIVE_FOLDER_HEIGHT_VIOLATION",
@@ -104,18 +145,35 @@
"DELETED_FOLDER_HEIGHT_VIOLATION"
],
"description": "The type of operation error experienced.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The error type was unrecognized or unspecified.",
+ "The attempted action would violate the max folder depth constraint.",
+ "The attempted action would violate the max child folders constraint.",
+ "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
+ "The resource being moved has been deleted.",
+ "The resource a folder was being added to has been deleted.",
+ "The attempted action would introduce cycle in resource path.",
+ "The attempted action would move a folder that is already being moved.",
+ "The folder the caller is trying to delete contains active resources.",
+ "The attempted action would violate the max deleted folder depth\nconstraint."
+ ]
}
},
- "id": "FolderOperationError"
+ "id": "FolderOperationError",
+ "description": "A classification of the Folder Operation error.",
+ "type": "object"
},
"FolderOperation": {
+ "id": "FolderOperation",
"description": "Metadata describing a long running folder operation",
"type": "object",
"properties": {
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ },
"operationType": {
- "description": "The type of this operation.",
- "type": "string",
"enumDescriptions": [
"Operation type not specified.",
"A create folder operation.",
@@ -125,7 +183,9 @@
"OPERATION_TYPE_UNSPECIFIED",
"CREATE",
"MOVE"
- ]
+ ],
+ "description": "The type of this operation.",
+ "type": "string"
},
"sourceParent": {
"description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
@@ -134,25 +194,13 @@
"displayName": {
"description": "The display name of the folder.",
"type": "string"
- },
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
}
- },
- "id": "FolderOperation"
+ }
},
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "items": {
- "$ref": "AuditConfig"
- },
- "type": "array"
- },
"bindings": {
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"items": {
@@ -169,12 +217,18 @@
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer"
+ },
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "AuditConfig"
+ },
+ "type": "array"
}
},
"id": "Policy"
},
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"done": {
@@ -190,8 +244,8 @@
"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": {
"$ref": "Status",
@@ -206,118 +260,118 @@
}
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
},
"AuditConfig": {
+ "id": "AuditConfig",
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
+ },
+ "service": {
+ "type": "string",
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services."
}
- },
- "id": "AuditConfig"
+ }
},
"ListFoldersResponse": {
+ "id": "ListFoldersResponse",
"description": "The ListFolders response message.",
"type": "object",
"properties": {
- "folders": {
- "description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource.",
- "items": {
- "$ref": "Folder"
- },
- "type": "array"
- },
"nextPageToken": {
"description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
"type": "string"
+ },
+ "folders": {
+ "items": {
+ "$ref": "Folder"
+ },
+ "type": "array",
+ "description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource."
}
- },
- "id": "ListFoldersResponse"
+ }
},
"MoveFolderRequest": {
"description": "The MoveFolder request message.",
"type": "object",
"properties": {
"destinationParent": {
- "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
- "type": "string"
+ "type": "string",
+ "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`."
}
},
"id": "MoveFolderRequest"
},
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "format": "google-fieldmask",
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "type": "string"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
"SearchFoldersResponse": {
"description": "The response message for searching folders.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.",
- "type": "string"
- },
"folders": {
"description": "A possibly paginated folder search results.\nthe specified parent resource.",
"items": {
"$ref": "Folder"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional."
}
},
"id": "SearchFoldersResponse"
},
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "type": "string"
- },
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- }
- },
- "id": "SetIamPolicyRequest"
- },
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
"code": {
+ "type": "integer",
"format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
+ "description": "The status code, which should be an enum value of google.rpc.Code."
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
}
},
- "id": "Status"
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
},
"Binding": {
- "description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"members": {
@@ -332,12 +386,17 @@
"type": "string"
}
},
- "id": "Binding"
+ "id": "Binding",
+ "description": "Associates `members` with a `role`."
},
"SearchFoldersRequest": {
"description": "The request message for searching folders.",
"type": "object",
"properties": {
+ "pageToken": {
+ "type": "string",
+ "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional."
+ },
"pageSize": {
"format": "int32",
"description": "The maximum number of folders to return in the response.\nThis field is optional.",
@@ -346,71 +405,9 @@
"query": {
"description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example queries are:\n|Query|Description|\n|------|-----------|\n|displayName=Test*|Folders whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.|\n|parent=folders/123|Folders whose parent is \"folders/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose\nparent is \"folders/123\".|",
"type": "string"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.",
- "type": "string"
}
},
"id": "SearchFoldersRequest"
- },
- "Folder": {
- "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
- "type": "object",
- "properties": {
- "createTime": {
- "format": "google-datetime",
- "description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
- "type": "string"
- },
- "lifecycleState": {
- "enumDescriptions": [
- "Unspecified state.",
- "The normal and active state.",
- "The folder has been marked for deletion by the user."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
- ],
- "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\n[DeleteFolder] and [UndeleteFolder].",
- "type": "string"
- },
- "name": {
- "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
- "type": "string"
- },
- "displayName": {
- "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.",
- "type": "string"
- },
- "parent": {
- "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via [MoveFolders].",
- "type": "string"
- }
- },
- "id": "Folder"
- },
- "ProjectCreationStatus": {
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object",
- "properties": {
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
- },
- "gettable": {
- "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
- "type": "boolean"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Creation time of the project creation workflow.",
- "type": "string"
- }
- },
- "id": "ProjectCreationStatus"
}
},
"protocol": "rest",
@@ -441,125 +438,6 @@
"resources": {
"folders": {
"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.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- },
- "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions",
- "path": "v2beta1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.folders.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call."
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Folder"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}",
- "path": "v2beta1/{+name}",
- "id": "cloudresourcemanager.folders.delete",
- "description": "Requests deletion of a Folder. The Folder is moved into the\n[DELETE_REQUESTED] state immediately, and is deleted approximately 30 days\nlater. This method may only be called on an empty Folder in the [ACTIVE]\nstate, where a Folder is empty if it doesn't contain any Folders or\nProjects in the [ACTIVE] state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder."
- },
- "list": {
- "description": "Lists the Folders that are direct descendants of supplied parent resource.\nList provides a strongly consistent view of the Folders underneath\nthe specified parent resource.\nList returns Folders sorted based upon the (ascending) lexical ordering\nof their display_name.\nThe caller must have `resourcemanager.folders.list` permission on the\nidentified parent.",
- "response": {
- "$ref": "ListFoldersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of Folders to return in the response.\nThis field is optional.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "query",
- "description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
- "type": "string"
- },
- "showDeleted": {
- "description": "Controls whether Folders in the [DELETE_REQUESTED} state should\nbe returned.",
- "type": "boolean",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
- "type": "string"
- }
- },
- "flatPath": "v2beta1/folders",
- "id": "cloudresourcemanager.folders.list",
- "path": "v2beta1/folders"
- },
- "setIamPolicy": {
- "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy",
- "path": "v2beta1/{+resource}:setIamPolicy",
- "id": "cloudresourcemanager.folders.setIamPolicy"
- },
"create": {
"description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
"request": {
@@ -572,9 +450,9 @@
"httpMethod": "POST",
"parameters": {
"parent": {
+ "type": "string",
"location": "query",
- "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
- "type": "string"
+ "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`."
}
},
"scopes": [
@@ -584,11 +462,39 @@
"id": "cloudresourcemanager.folders.create",
"path": "v2beta1/folders"
},
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy",
+ "path": "v2beta1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.folders.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder."
+ },
"getIamPolicy": {
+ "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
"request": {
"$ref": "GetIamPolicyRequest"
},
- "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
"response": {
"$ref": "Policy"
},
@@ -596,108 +502,53 @@
"resource"
],
"httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
"flatPath": "v2beta1/folders/{foldersId}:getIamPolicy",
"id": "cloudresourcemanager.folders.getIamPolicy",
"path": "v2beta1/{+resource}:getIamPolicy"
},
"search": {
- "flatPath": "v2beta1/folders:search",
- "id": "cloudresourcemanager.folders.search",
"path": "v2beta1/folders:search",
+ "id": "cloudresourcemanager.folders.search",
"description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`.",
"request": {
"$ref": "SearchFoldersRequest"
},
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "SearchFoldersResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "undelete": {
- "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the [DELETE_REQUESTED] state.\nIn order to succeed, the Folder's parent must be in the [ACTIVE] state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\n[CreateFolder] documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder.",
- "request": {
- "$ref": "UndeleteFolderRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
],
+ "flatPath": "v2beta1/folders:search"
+ },
+ "patch": {
"response": {
"$ref": "Folder"
},
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/folders/{foldersId}:undelete",
- "path": "v2beta1/{+name}:undelete",
- "id": "cloudresourcemanager.folders.undelete"
- },
- "get": {
- "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder.",
- "response": {
- "$ref": "Folder"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v2beta1/folders/{foldersId}",
- "id": "cloudresourcemanager.folders.get",
- "path": "v2beta1/{+name}"
- },
- "patch": {
- "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in\nthe [CreateFolder] documentation.\n+ The Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field.",
- "request": {
- "$ref": "Folder"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Folder"
- },
"parameters": {
"updateMask": {
"format": "google-fieldmask",
@@ -706,7 +557,58 @@
"location": "query"
},
"name": {
- "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\"."
+ }
+ },
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "id": "cloudresourcemanager.folders.patch",
+ "path": "v2beta1/{+name}",
+ "request": {
+ "$ref": "Folder"
+ },
+ "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in\nthe [CreateFolder] documentation.\n+ The Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Folder"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "path": "v2beta1/{+name}",
+ "id": "cloudresourcemanager.folders.get",
+ "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder."
+ },
+ "undelete": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Folder"
+ },
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
"type": "string",
"required": true,
"pattern": "^folders/[^/]+$",
@@ -716,11 +618,17 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/folders/{foldersId}",
- "path": "v2beta1/{+name}",
- "id": "cloudresourcemanager.folders.patch"
+ "flatPath": "v2beta1/folders/{foldersId}:undelete",
+ "path": "v2beta1/{+name}:undelete",
+ "id": "cloudresourcemanager.folders.undelete",
+ "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the [DELETE_REQUESTED] state.\nIn order to succeed, the Folder's parent must be in the [ACTIVE] state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\n[CreateFolder] documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder.",
+ "request": {
+ "$ref": "UndeleteFolderRequest"
+ }
},
"move": {
+ "path": "v2beta1/{+name}:move",
+ "id": "cloudresourcemanager.folders.move",
"request": {
"$ref": "MoveFolderRequest"
},
@@ -737,16 +645,105 @@
],
"parameters": {
"name": {
- "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
"type": "string",
"required": true,
"pattern": "^folders/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}"
}
},
- "flatPath": "v2beta1/folders/{foldersId}:move",
- "path": "v2beta1/{+name}:move",
- "id": "cloudresourcemanager.folders.move"
+ "flatPath": "v2beta1/folders/{foldersId}:move"
+ },
+ "testIamPermissions": {
+ "path": "v2beta1/{+resource}:testIamPermissions",
+ "id": "cloudresourcemanager.folders.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions"
+ },
+ "delete": {
+ "description": "Requests deletion of a Folder. The Folder is moved into the\n[DELETE_REQUESTED] state immediately, and is deleted approximately 30 days\nlater. This method may only be called on an empty Folder in the [ACTIVE]\nstate, where a Folder is empty if it doesn't contain any Folders or\nProjects in the [ACTIVE] state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder.",
+ "response": {
+ "$ref": "Folder"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "id": "cloudresourcemanager.folders.delete",
+ "path": "v2beta1/{+name}"
+ },
+ "list": {
+ "flatPath": "v2beta1/folders",
+ "path": "v2beta1/folders",
+ "id": "cloudresourcemanager.folders.list",
+ "description": "Lists the Folders that are direct descendants of supplied parent resource.\nList provides a strongly consistent view of the Folders underneath\nthe specified parent resource.\nList returns Folders sorted based upon the (ascending) lexical ordering\nof their display_name.\nThe caller must have `resourcemanager.folders.list` permission on the\nidentified parent.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListFoldersResponse"
+ },
+ "parameterOrder": [],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "query",
+ "description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
+ "type": "string"
+ },
+ "showDeleted": {
+ "location": "query",
+ "description": "Controls whether Folders in the [DELETE_REQUESTED} state should\nbe returned.",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of Folders to return in the response.\nThis field is optional."
+ }
+ }
}
}
}
@@ -758,38 +755,38 @@
"type": "string"
},
"prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
- "location": "query"
- },
- "uploadType": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "description": "Returns response with indentations and line breaks."
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
+ "uploadType": {
"location": "query",
- "description": "JSONP",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
"description": "Data format for response.",
@@ -818,25 +815,25 @@
"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"
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "boolean"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
}
},
"version": "v2beta1",
@@ -844,5 +841,8 @@
"kind": "discovery#restDescription",
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"servicePath": "",
- "basePath": ""
+ "basePath": "",
+ "revision": "20170821",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "id": "cloudresourcemanager:v2beta1"
}
diff --git a/cloudtrace/v1/cloudtrace-api.json b/cloudtrace/v1/cloudtrace-api.json
index 30eaeac..bb3b190 100644
--- a/cloudtrace/v1/cloudtrace-api.json
+++ b/cloudtrace/v1/cloudtrace-api.json
@@ -1,4 +1,151 @@
{
+ "kind": "discovery#restDescription",
+ "description": "Send and retrieve trace data from Stackdriver Trace. Data is generated and available by default for all App Engine applications. Data from other applications can be written to Stackdriver Trace for display, reporting, and analysis.\n",
+ "servicePath": "",
+ "basePath": "",
+ "id": "cloudtrace:v1",
+ "documentationLink": "https://cloud.google.com/trace",
+ "revision": "20170815",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "TraceSpan": {
+ "type": "object",
+ "properties": {
+ "spanId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace."
+ },
+ "parentSpanId": {
+ "format": "uint64",
+ "description": "ID of the parent span, if any. Optional.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "End time of the span in nanoseconds from the UNIX epoch.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Start time of the span in nanoseconds from the UNIX epoch.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Indicates that the span covers server-side handling of an RPC or other\nremote network request.",
+ "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
+ ],
+ "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."
+ },
+ "labels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`"
+ },
+ "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."
+ }
+ },
+ "id": "TraceSpan",
+ "description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace."
+ },
+ "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"
+ },
+ "ListTracesResponse": {
+ "description": "The response message for the `ListTraces` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
+ "type": "string"
+ },
+ "traces": {
+ "description": "List of trace records returned.",
+ "items": {
+ "$ref": "Trace"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListTracesResponse"
+ },
+ "Trace": {
+ "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.",
+ "type": "object",
+ "properties": {
+ "spans": {
+ "description": "Collection of spans in the trace.",
+ "items": {
+ "$ref": "TraceSpan"
+ },
+ "type": "array"
+ },
+ "projectId": {
+ "description": "Project ID of the Cloud project where the trace data is stored.",
+ "type": "string"
+ },
+ "traceId": {
+ "type": "string",
+ "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string."
+ }
+ },
+ "id": "Trace"
+ },
+ "Traces": {
+ "type": "object",
+ "properties": {
+ "traces": {
+ "items": {
+ "$ref": "Trace"
+ },
+ "type": "array",
+ "description": "List of traces."
+ }
+ },
+ "id": "Traces",
+ "description": "List of new or updated traces."
+ }
+ },
+ "protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "canonicalName": "Cloud Trace",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/trace.readonly": {
+ "description": "Read Trace data for a project or application"
+ },
+ "https://www.googleapis.com/auth/trace.append": {
+ "description": "Write Trace data for a project or application"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudtrace.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudtrace",
"batchPath": "batch",
"title": "Stackdriver Trace API",
"ownerName": "Google",
@@ -39,24 +186,24 @@
"methods": {
"get": {
"description": "Gets a single trace by its ID.",
- "response": {
- "$ref": "Trace"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"projectId",
"traceId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Trace"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
],
"parameters": {
"projectId": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored."
},
"traceId": {
"type": "string",
@@ -66,55 +213,39 @@
}
},
"flatPath": "v1/projects/{projectId}/traces/{traceId}",
- "id": "cloudtrace.projects.traces.get",
- "path": "v1/projects/{projectId}/traces/{traceId}"
+ "path": "v1/projects/{projectId}/traces/{traceId}",
+ "id": "cloudtrace.projects.traces.get"
},
"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.",
- "httpMethod": "GET",
"response": {
"$ref": "ListTracesResponse"
},
"parameterOrder": [
"projectId"
],
+ "httpMethod": "GET",
"parameters": {
- "orderBy": {
- "description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
- "type": "string",
- "required": true
- },
- "filter": {
- "location": "query",
- "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
- "type": "string"
- },
"endTime": {
"location": "query",
"format": "google-datetime",
"description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
"type": "string"
},
+ "pageToken": {
+ "location": "query",
+ "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
+ "type": "string"
+ },
"startTime": {
"type": "string",
"location": "query",
"format": "google-datetime",
"description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application."
},
- "pageToken": {
- "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
"location": "query",
"format": "int32",
@@ -122,6 +253,7 @@
"type": "integer"
},
"view": {
+ "location": "query",
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"MINIMAL",
@@ -129,8 +261,23 @@
"COMPLETE"
],
"description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
+ "type": "string"
+ },
+ "orderBy": {
"type": "string",
- "location": "query"
+ "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."
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "type": "string",
+ "required": true
+ },
+ "filter": {
+ "type": "string",
+ "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`."
}
},
"scopes": [
@@ -144,43 +291,23 @@
}
},
"parameters": {
- "oauth_token": {
+ "fields": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "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.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"callback": {
"type": "string",
"location": "query",
"description": "JSONP"
},
"$.xgafv": {
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -190,10 +317,15 @@
"1",
"2"
],
- "description": "V1 error format.",
- "type": "string"
+ "description": "V1 error format."
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -201,183 +333,51 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
},
"access_token": {
- "description": "OAuth access token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth access token."
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "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": {
+ "default": "true",
+ "type": "boolean",
"location": "query",
- "description": "Pretty-print response.",
+ "description": "Pretty-print response."
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
}
},
"version": "v1",
- "baseUrl": "https://cloudtrace.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Send and retrieve trace data from Stackdriver Trace. Data is generated and available by default for all App Engine applications. Data from other applications can be written to Stackdriver Trace for display, reporting, and analysis.\n",
- "servicePath": "",
- "basePath": "",
- "revision": "20170815",
- "documentationLink": "https://cloud.google.com/trace",
- "id": "cloudtrace:v1",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "Trace": {
- "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.",
- "type": "object",
- "properties": {
- "spans": {
- "description": "Collection of spans in the trace.",
- "items": {
- "$ref": "TraceSpan"
- },
- "type": "array"
- },
- "projectId": {
- "description": "Project ID of the Cloud project where the trace data is stored.",
- "type": "string"
- },
- "traceId": {
- "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string.",
- "type": "string"
- }
- },
- "id": "Trace"
- },
- "Traces": {
- "properties": {
- "traces": {
- "description": "List of traces.",
- "items": {
- "$ref": "Trace"
- },
- "type": "array"
- }
- },
- "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": {
- "name": {
- "description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans.",
- "type": "string"
- },
- "spanId": {
- "format": "uint64",
- "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.",
- "type": "string"
- },
- "parentSpanId": {
- "format": "uint64",
- "description": "ID of the parent span, if any. Optional.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "End time of the span in nanoseconds from the UNIX epoch.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Start time of the span in nanoseconds from the UNIX epoch.",
- "type": "string"
- },
- "kind": {
- "enum": [
- "SPAN_KIND_UNSPECIFIED",
- "RPC_SERVER",
- "RPC_CLIENT"
- ],
- "description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Indicates that the span covers server-side handling of an RPC or other\nremote network request.",
- "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
- ]
- },
- "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"
- }
- },
- "id": "TraceSpan"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ListTracesResponse": {
- "description": "The response message for the `ListTraces` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.",
- "type": "string"
- },
- "traces": {
- "description": "List of trace records returned.",
- "items": {
- "$ref": "Trace"
- },
- "type": "array"
- }
- },
- "id": "ListTracesResponse"
- }
- },
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud Trace",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/trace.readonly": {
- "description": "Read Trace data for a project or application"
- },
- "https://www.googleapis.com/auth/trace.append": {
- "description": "Write Trace data for a project or application"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudtrace.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudtrace"
+ "baseUrl": "https://cloudtrace.googleapis.com/"
}
diff --git a/cloudtrace/v2/cloudtrace-api.json b/cloudtrace/v2/cloudtrace-api.json
index 8439437..dcf8511 100644
--- a/cloudtrace/v2/cloudtrace-api.json
+++ b/cloudtrace/v2/cloudtrace-api.json
@@ -1,458 +1,4 @@
{
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "Link": {
- "id": "Link",
- "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "The relationship of the two spans is unknown.",
- "The linked span is a child of the current span.",
- "The linked span is a parent of the current span."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "CHILD_LINKED_SPAN",
- "PARENT_LINKED_SPAN"
- ],
- "description": "The relationship of the current span relative to the linked span.",
- "type": "string"
- },
- "attributes": {
- "$ref": "Attributes",
- "description": "A set of attributes on the link. There is a limit of 32 attributes per\nlink."
- },
- "traceId": {
- "description": "`TRACE_ID` identifies a trace within a project.",
- "type": "string"
- },
- "spanId": {
- "description": "`SPAN_ID` identifies a span within a trace.",
- "type": "string"
- }
- }
- },
- "Annotation": {
- "description": "Text annotation with a set of attributes.",
- "type": "object",
- "properties": {
- "description": {
- "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes.",
- "$ref": "TruncatableString"
- },
- "attributes": {
- "$ref": "Attributes",
- "description": "A set of attributes on the annotation. There is a limit of 4 attributes\nper Annotation."
- }
- },
- "id": "Annotation"
- },
- "StackFrames": {
- "type": "object",
- "properties": {
- "droppedFramesCount": {
- "type": "integer",
- "format": "int32",
- "description": "The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack frames were dropped."
- },
- "frame": {
- "description": "Stack frames in this call stack.",
- "items": {
- "$ref": "StackFrame"
- },
- "type": "array"
- }
- },
- "id": "StackFrames",
- "description": "A collection of stack frames, which can be truncated."
- },
- "Trace": {
- "description": "A trace describes how long it takes for an application to perform some\noperations. It consists of a set of spans, each representing\nan operation and including time information and operation details.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The resource name of the trace in the following format:\n\n projects/[PROJECT_ID]/traces/TRACE_ID is a unique identifier for a trace within a project.\nThe ID is assigned when the trace is created.",
- "type": "string"
- }
- },
- "id": "Trace"
- },
- "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": {
- "timeEvent": {
- "items": {
- "$ref": "TimeEvent"
- },
- "type": "array",
- "description": "A collection of `TimeEvent`s."
- },
- "droppedNetworkEventsCount": {
- "type": "integer",
- "format": "int32",
- "description": "The number of dropped network events in all the included time events.\nIf the value is 0, then no network events were dropped."
- },
- "droppedAnnotationsCount": {
- "format": "int32",
- "description": "The number of dropped annotations in all the included time events.\nIf the value is 0, then no annotations were dropped.",
- "type": "integer"
- }
- },
- "id": "TimeEvents"
- },
- "Module": {
- "description": "Binary module.",
- "type": "object",
- "properties": {
- "module": {
- "description": "For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes).",
- "$ref": "TruncatableString"
- },
- "buildId": {
- "$ref": "TruncatableString",
- "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)."
- }
- },
- "id": "Module"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "BatchWriteSpansRequest": {
- "id": "BatchWriteSpansRequest",
- "description": "The request message for the `BatchWriteSpans` method.",
- "type": "object",
- "properties": {
- "spans": {
- "description": "A collection of spans.",
- "items": {
- "$ref": "Span"
- },
- "type": "array"
- }
- }
- },
- "Span": {
- "description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous—there may be\ngaps or overlaps between spans in a trace.",
- "type": "object",
- "properties": {
- "links": {
- "description": "A maximum of 128 links are allowed per Span.",
- "$ref": "Links"
- },
- "attributes": {
- "description": "A set of attributes on the span. There is a limit of 32 attributes per\nspan.",
- "$ref": "Attributes"
- },
- "spanId": {
- "description": "The [SPAN_ID] portion of the span's resource name.",
- "type": "string"
- },
- "childSpanCount": {
- "format": "uint32",
- "description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect missing child spans.",
- "type": "integer"
- },
- "sameProcessAsParentSpan": {
- "description": "A highly recommended but not required flag that identifies when a trace\ncrosses a process boundary. True when the parent_span belongs to the\nsame process as the current span.",
- "type": "boolean"
- },
- "status": {
- "$ref": "Status",
- "description": "An optional final status for this span."
- },
- "name": {
- "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project.\n[SPAN_ID] is a unique identifier for a span within a trace,\nassigned when the span is created.",
- "type": "string"
- },
- "stackTrace": {
- "$ref": "StackTrace",
- "description": "Stack trace captured at the start of the span."
- },
- "parentSpanId": {
- "description": "The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The end time of the span. On the client side, this is the time kept by\nthe local machine where the span execution ends. On the server side, this\nis the time when the server application handler stops running.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running.",
- "type": "string"
- },
- "displayName": {
- "$ref": "TruncatableString",
- "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces."
- },
- "timeEvents": {
- "$ref": "TimeEvents",
- "description": "The included time events. There can be up to 32 annotations and 128 network\nevents per span."
- }
- },
- "id": "Span"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ListTracesResponse": {
- "description": "The response message for the `ListTraces` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then\n`next_page_token` is included. To get the next set of results, call this\nmethod again using the value of `next_page_token` as `page_token`.",
- "type": "string"
- },
- "traces": {
- "description": "List of trace records returned.",
- "items": {
- "$ref": "Trace"
- },
- "type": "array"
- }
- },
- "id": "ListTracesResponse"
- },
- "AttributeValue": {
- "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
- "type": "object",
- "properties": {
- "intValue": {
- "format": "int64",
- "description": "A 64-bit signed integer.",
- "type": "string"
- },
- "boolValue": {
- "description": "A Boolean value represented by `true` or `false`.",
- "type": "boolean"
- },
- "stringValue": {
- "$ref": "TruncatableString",
- "description": "A string up to 256 bytes long."
- }
- },
- "id": "AttributeValue"
- },
- "Attributes": {
- "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
- "type": "object",
- "properties": {
- "droppedAttributesCount": {
- "format": "int32",
- "description": "The number of attributes that were discarded. Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.",
- "type": "integer"
- },
- "attributeMap": {
- "additionalProperties": {
- "$ref": "AttributeValue"
- },
- "description": "The set of attributes. Each attribute's key can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, an integer, or the\nBoolean values `true` and `false`. For example:\n\n \"/instance_id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes\": 300\n \"abc.com/myattribute\": true",
- "type": "object"
- }
- },
- "id": "Attributes"
- },
- "Links": {
- "properties": {
- "droppedLinksCount": {
- "format": "int32",
- "description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
- "type": "integer"
- },
- "link": {
- "description": "A collection of links.",
- "items": {
- "$ref": "Link"
- },
- "type": "array"
- }
- },
- "id": "Links",
- "description": "A collection of links, which are references from this span to a span\nin the same or different trace.",
- "type": "object"
- },
- "TruncatableString": {
- "description": "Represents a string that might be shortened to a specified length.",
- "type": "object",
- "properties": {
- "truncatedByteCount": {
- "format": "int32",
- "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.",
- "type": "integer"
- },
- "value": {
- "description": "The shortened string. For example, if the original string was 500\nbytes long and the limit of the string was 128 bytes, then this\nvalue contains the first 128 bytes of the 500-byte string. Note that\ntruncation always happens on the character boundary, to ensure that\ntruncated string is still valid UTF8. In case of multi-byte characters,\nsize of truncated string can be less than truncation limit.",
- "type": "string"
- }
- },
- "id": "TruncatableString"
- },
- "StackTrace": {
- "description": "A call stack appearing in a trace.",
- "type": "object",
- "properties": {
- "stackTraceHashId": {
- "format": "uint64",
- "description": "The hash ID is used to conserve network bandwidth for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSubsequent spans within the same request can refer\nto that stack trace by only setting `stackTraceHashId`.",
- "type": "string"
- },
- "stackFrames": {
- "$ref": "StackFrames",
- "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
- }
- },
- "id": "StackTrace"
- },
- "TimeEvent": {
- "description": "A time-stamped annotation or network event in the Span.",
- "type": "object",
- "properties": {
- "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"
- },
- "time": {
- "format": "google-datetime",
- "description": "The timestamp indicating the time the event occurred.",
- "type": "string"
- }
- },
- "id": "TimeEvent"
- },
- "ListSpansResponse": {
- "description": "The response message for the `ListSpans` method.",
- "type": "object",
- "properties": {
- "spans": {
- "description": "The requested spans, if there are any in the specified trace.",
- "items": {
- "$ref": "Span"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "If defined, indicates that there might be more spans that match the\nrequest. Pass this as the value of `pageToken` in a subsequent request to\nretrieve additional spans.",
- "type": "string"
- }
- },
- "id": "ListSpansResponse"
- },
- "NetworkEvent": {
- "id": "NetworkEvent",
- "description": "An event describing an RPC message sent or received on the network.",
- "type": "object",
- "properties": {
- "time": {
- "format": "google-datetime",
- "description": "For sent messages, this is the time at which the first bit was sent.\nFor received messages, this is the time at which the last bit was\nreceived.",
- "type": "string"
- },
- "type": {
- "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."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "SENT",
- "RECV"
- ]
- },
- "messageId": {
- "format": "uint64",
- "description": "An identifier for the message, which must be unique in this span.",
- "type": "string"
- },
- "messageSize": {
- "type": "string",
- "format": "uint64",
- "description": "The number of bytes sent or received."
- }
- }
- },
- "StackFrame": {
- "description": "Represents a single stack frame in a stack trace.",
- "type": "object",
- "properties": {
- "originalFunctionName": {
- "$ref": "TruncatableString",
- "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes)."
- },
- "functionName": {
- "$ref": "TruncatableString",
- "description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes)."
- },
- "lineNumber": {
- "format": "int64",
- "description": "The line number in `file_name` where the function call appears.",
- "type": "string"
- },
- "loadModule": {
- "description": "The binary module from where the code was loaded.",
- "$ref": "Module"
- },
- "columnNumber": {
- "format": "int64",
- "description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.",
- "type": "string"
- },
- "fileName": {
- "$ref": "TruncatableString",
- "description": "The name of the source file where the function call appears (up to 256\nbytes)."
- },
- "sourceVersion": {
- "description": "The version of the deployed source code (up to 128 bytes).",
- "$ref": "TruncatableString"
- }
- },
- "id": "StackFrame"
- }
- },
- "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": {
@@ -481,13 +27,17 @@
"traces": {
"methods": {
"list": {
- "response": {
- "$ref": "ListTracesResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTracesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
"parameters": {
"filter": {
"location": "query",
@@ -495,16 +45,16 @@
"type": "string"
},
"endTime": {
- "format": "google-datetime",
- "description": "Optional. Do not return traces whose start time is later than this time.",
- "type": "string",
- "location": "query"
- },
- "startTime": {
- "type": "string",
"location": "query",
"format": "google-datetime",
- "description": "Optional. Do not return traces whose end time is earlier than this time."
+ "description": "Optional. Do not return traces whose start time is later than this time.",
+ "type": "string"
+ },
+ "startTime": {
+ "location": "query",
+ "format": "google-datetime",
+ "description": "Optional. Do not return traces whose end time is earlier than this time.",
+ "type": "string"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the\npreceding call to this method. `page_token` must be the value of\n`next_page_token` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
@@ -518,11 +68,11 @@
"type": "integer"
},
"parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
"description": "Required. The project where the trace data is stored. The format\nis `projects/PROJECT_ID`.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
},
"orderBy": {
"description": "Optional. A single field used to sort the returned traces.\nOnly the following field names can be used:\n\n* `trace_id`: the trace's ID field\n* `name`: the root span's resource name\n* `duration`: the difference between the root span's start time and end time\n* `start`: the start time of the root span\n\nSorting is in ascending order unless `desc` is appended to the sort field name.\nExample: `\"name desc\"`).",
@@ -530,84 +80,76 @@
"location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
"flatPath": "v2/projects/{projectsId}/traces",
- "id": "cloudtrace.projects.traces.list",
"path": "v2/{+parent}/traces",
+ "id": "cloudtrace.projects.traces.list",
"description": "Returns of a list of traces that match the specified filter conditions."
},
"batchWrite": {
- "response": {
- "$ref": "Empty"
+ "flatPath": "v2/projects/{projectsId}/traces:batchWrite",
+ "path": "v2/{+name}/traces:batchWrite",
+ "id": "cloudtrace.projects.traces.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"
],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "Required. Name of the project where the spans belong. The format is\n`projects/PROJECT_ID`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
+ "response": {
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
- "flatPath": "v2/projects/{projectsId}/traces:batchWrite",
- "id": "cloudtrace.projects.traces.batchWrite",
- "path": "v2/{+name}/traces:batchWrite",
- "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.",
- "request": {
- "$ref": "BatchWriteSpansRequest"
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. Name of the project where the spans belong. The format is\n`projects/PROJECT_ID`.",
+ "type": "string",
+ "required": true
+ }
}
},
"listSpans": {
- "parameterOrder": [
- "parent"
- ],
+ "description": "Returns a list of spans within a trace.",
"response": {
"$ref": "ListSpansResponse"
},
+ "parameterOrder": [
+ "parent"
+ ],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
],
"parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the\npreceding call to this method. `page_token` must be the value of\n`next_page_token` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
+ "type": "string"
+ },
"parent": {
"description": "Required: The resource name of the trace containing the spans to list.\nThe format is `projects/PROJECT_ID/traces/TRACE_ID`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/traces/[^/]+$",
"location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the\npreceding call to this method. `page_token` must be the value of\n`next_page_token` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
- "type": "string"
}
},
"flatPath": "v2/projects/{projectsId}/traces/{tracesId}:listSpans",
"id": "cloudtrace.projects.traces.listSpans",
- "path": "v2/{+parent}:listSpans",
- "description": "Returns a list of spans within a trace."
+ "path": "v2/{+parent}:listSpans"
}
},
"resources": {
"spans": {
"methods": {
"create": {
- "description": "Creates a new Span.",
- "request": {
- "$ref": "Span"
- },
"response": {
"$ref": "Span"
},
@@ -630,7 +172,11 @@
],
"flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}",
"id": "cloudtrace.projects.traces.spans.create",
- "path": "v2/{+name}"
+ "path": "v2/{+name}",
+ "description": "Creates a new Span.",
+ "request": {
+ "$ref": "Span"
+ }
}
}
}
@@ -640,26 +186,41 @@
}
},
"parameters": {
- "upload_protocol": {
- "type": "string",
+ "oauth_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "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": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -674,35 +235,30 @@
"description": "V1 error format.",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
- "type": "string"
+ "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.",
+ "access_token": {
+ "description": "OAuth access token.",
"type": "string",
"location": "query"
},
- "access_token": {
+ "key": {
"location": "query",
- "description": "OAuth access token.",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
"quotaUser": {
@@ -711,19 +267,9 @@
"type": "string"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
+ "type": "boolean",
"location": "query"
}
},
@@ -733,7 +279,461 @@
"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": "20170815",
+ "documentationLink": "https://cloud.google.com/trace",
"id": "cloudtrace:v2",
- "documentationLink": "https://cloud.google.com/trace"
+ "revision": "20170815",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "Links": {
+ "type": "object",
+ "properties": {
+ "link": {
+ "description": "A collection of links.",
+ "items": {
+ "$ref": "Link"
+ },
+ "type": "array"
+ },
+ "droppedLinksCount": {
+ "format": "int32",
+ "description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
+ "type": "integer"
+ }
+ },
+ "id": "Links",
+ "description": "A collection of links, which are references from this span to a span\nin the same or different trace."
+ },
+ "StackTrace": {
+ "id": "StackTrace",
+ "description": "A call stack appearing in a trace.",
+ "type": "object",
+ "properties": {
+ "stackTraceHashId": {
+ "format": "uint64",
+ "description": "The hash ID is used to conserve network bandwidth for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSubsequent spans within the same request can refer\nto that stack trace by only setting `stackTraceHashId`.",
+ "type": "string"
+ },
+ "stackFrames": {
+ "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed.",
+ "$ref": "StackFrames"
+ }
+ }
+ },
+ "TruncatableString": {
+ "description": "Represents a string that might be shortened to a specified length.",
+ "type": "object",
+ "properties": {
+ "truncatedByteCount": {
+ "format": "int32",
+ "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.",
+ "type": "integer"
+ },
+ "value": {
+ "description": "The shortened string. For example, if the original string was 500\nbytes long and the limit of the string was 128 bytes, then this\nvalue contains the first 128 bytes of the 500-byte string. Note that\ntruncation always happens on the character boundary, to ensure that\ntruncated string is still valid UTF8. In case of multi-byte characters,\nsize of truncated string can be less than truncation limit.",
+ "type": "string"
+ }
+ },
+ "id": "TruncatableString"
+ },
+ "TimeEvent": {
+ "description": "A time-stamped annotation or network event in the Span.",
+ "type": "object",
+ "properties": {
+ "time": {
+ "format": "google-datetime",
+ "description": "The timestamp indicating the time the event occurred.",
+ "type": "string"
+ },
+ "networkEvent": {
+ "$ref": "NetworkEvent",
+ "description": "An event describing an RPC message sent/received on the network."
+ },
+ "annotation": {
+ "$ref": "Annotation",
+ "description": "One or more key:value pairs."
+ }
+ },
+ "id": "TimeEvent"
+ },
+ "NetworkEvent": {
+ "description": "An event describing an RPC message sent or received on the network.",
+ "type": "object",
+ "properties": {
+ "messageSize": {
+ "format": "uint64",
+ "description": "The number of bytes sent or received.",
+ "type": "string"
+ },
+ "time": {
+ "format": "google-datetime",
+ "description": "For sent messages, this is the time at which the first bit was sent.\nFor received messages, this is the time at which the last bit was\nreceived.",
+ "type": "string"
+ },
+ "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"
+ },
+ "messageId": {
+ "type": "string",
+ "format": "uint64",
+ "description": "An identifier for the message, which must be unique in this span."
+ }
+ },
+ "id": "NetworkEvent"
+ },
+ "ListSpansResponse": {
+ "id": "ListSpansResponse",
+ "description": "The response message for the `ListSpans` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If defined, indicates that there might be more spans that match the\nrequest. Pass this as the value of `pageToken` in a subsequent request to\nretrieve additional spans.",
+ "type": "string"
+ },
+ "spans": {
+ "description": "The requested spans, if there are any in the specified trace.",
+ "items": {
+ "$ref": "Span"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "StackFrame": {
+ "description": "Represents a single stack frame in a stack trace.",
+ "type": "object",
+ "properties": {
+ "lineNumber": {
+ "format": "int64",
+ "description": "The line number in `file_name` where the function call appears.",
+ "type": "string"
+ },
+ "loadModule": {
+ "description": "The binary module from where the code was loaded.",
+ "$ref": "Module"
+ },
+ "columnNumber": {
+ "format": "int64",
+ "description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.",
+ "type": "string"
+ },
+ "fileName": {
+ "$ref": "TruncatableString",
+ "description": "The name of the source file where the function call appears (up to 256\nbytes)."
+ },
+ "sourceVersion": {
+ "$ref": "TruncatableString",
+ "description": "The version of the deployed source code (up to 128 bytes)."
+ },
+ "originalFunctionName": {
+ "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes).",
+ "$ref": "TruncatableString"
+ },
+ "functionName": {
+ "description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes).",
+ "$ref": "TruncatableString"
+ }
+ },
+ "id": "StackFrame"
+ },
+ "Link": {
+ "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "The relationship of the two spans is unknown.",
+ "The linked span is a child of the current span.",
+ "The linked span is a parent of the current span."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CHILD_LINKED_SPAN",
+ "PARENT_LINKED_SPAN"
+ ],
+ "description": "The relationship of the current span relative to the linked span."
+ },
+ "attributes": {
+ "$ref": "Attributes",
+ "description": "A set of attributes on the link. There is a limit of 32 attributes per\nlink."
+ },
+ "traceId": {
+ "description": "`TRACE_ID` identifies a trace within a project.",
+ "type": "string"
+ },
+ "spanId": {
+ "description": "`SPAN_ID` identifies a span within a trace.",
+ "type": "string"
+ }
+ },
+ "id": "Link"
+ },
+ "Annotation": {
+ "description": "Text annotation with a set of attributes.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes.",
+ "$ref": "TruncatableString"
+ },
+ "attributes": {
+ "description": "A set of attributes on the annotation. There is a limit of 4 attributes\nper Annotation.",
+ "$ref": "Attributes"
+ }
+ },
+ "id": "Annotation"
+ },
+ "StackFrames": {
+ "description": "A collection of stack frames, which can be truncated.",
+ "type": "object",
+ "properties": {
+ "droppedFramesCount": {
+ "format": "int32",
+ "description": "The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack frames were dropped.",
+ "type": "integer"
+ },
+ "frame": {
+ "description": "Stack frames in this call stack.",
+ "items": {
+ "$ref": "StackFrame"
+ },
+ "type": "array"
+ }
+ },
+ "id": "StackFrames"
+ },
+ "Trace": {
+ "description": "A trace describes how long it takes for an application to perform some\noperations. It consists of a set of spans, each representing\nan operation and including time information and operation details.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name of the trace in the following format:\n\n projects/[PROJECT_ID]/traces/TRACE_ID is a unique identifier for a trace within a project.\nThe ID is assigned when the trace is created.",
+ "type": "string"
+ }
+ },
+ "id": "Trace"
+ },
+ "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": {
+ "droppedAnnotationsCount": {
+ "format": "int32",
+ "description": "The number of dropped annotations in all the included time events.\nIf the value is 0, then no annotations were dropped.",
+ "type": "integer"
+ },
+ "timeEvent": {
+ "description": "A collection of `TimeEvent`s.",
+ "items": {
+ "$ref": "TimeEvent"
+ },
+ "type": "array"
+ },
+ "droppedNetworkEventsCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of dropped network events in all the included time events.\nIf the value is 0, then no network events were dropped."
+ }
+ },
+ "id": "TimeEvents"
+ },
+ "Module": {
+ "id": "Module",
+ "description": "Binary module.",
+ "type": "object",
+ "properties": {
+ "buildId": {
+ "$ref": "TruncatableString",
+ "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)."
+ },
+ "module": {
+ "$ref": "TruncatableString",
+ "description": "For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes)."
+ }
+ }
+ },
+ "Status": {
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
+ },
+ "BatchWriteSpansRequest": {
+ "type": "object",
+ "properties": {
+ "spans": {
+ "description": "A collection of spans.",
+ "items": {
+ "$ref": "Span"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchWriteSpansRequest",
+ "description": "The request message for the `BatchWriteSpans` method."
+ },
+ "Span": {
+ "type": "object",
+ "properties": {
+ "childSpanCount": {
+ "format": "uint32",
+ "description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect missing child spans.",
+ "type": "integer"
+ },
+ "sameProcessAsParentSpan": {
+ "description": "A highly recommended but not required flag that identifies when a trace\ncrosses a process boundary. True when the parent_span belongs to the\nsame process as the current span.",
+ "type": "boolean"
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "An optional final status for this span."
+ },
+ "name": {
+ "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project.\n[SPAN_ID] is a unique identifier for a span within a trace,\nassigned when the span is created.",
+ "type": "string"
+ },
+ "stackTrace": {
+ "description": "Stack trace captured at the start of the span.",
+ "$ref": "StackTrace"
+ },
+ "parentSpanId": {
+ "type": "string",
+ "description": "The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty."
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The end time of the span. On the client side, this is the time kept by\nthe local machine where the span execution ends. On the server side, this\nis the time when the server application handler stops running.",
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running."
+ },
+ "displayName": {
+ "$ref": "TruncatableString",
+ "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces."
+ },
+ "timeEvents": {
+ "$ref": "TimeEvents",
+ "description": "The included time events. There can be up to 32 annotations and 128 network\nevents per 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. There is a limit of 32 attributes per\nspan."
+ },
+ "spanId": {
+ "description": "The [SPAN_ID] portion of the span's resource name.",
+ "type": "string"
+ }
+ },
+ "id": "Span",
+ "description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous—there may be\ngaps or overlaps between spans in a trace."
+ },
+ "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"
+ },
+ "ListTracesResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then\n`next_page_token` is included. To get the next set of results, call this\nmethod again using the value of `next_page_token` as `page_token`.",
+ "type": "string"
+ },
+ "traces": {
+ "items": {
+ "$ref": "Trace"
+ },
+ "type": "array",
+ "description": "List of trace records returned."
+ }
+ },
+ "id": "ListTracesResponse",
+ "description": "The response message for the `ListTraces` method."
+ },
+ "AttributeValue": {
+ "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
+ "type": "object",
+ "properties": {
+ "boolValue": {
+ "description": "A Boolean value represented by `true` or `false`.",
+ "type": "boolean"
+ },
+ "stringValue": {
+ "$ref": "TruncatableString",
+ "description": "A string up to 256 bytes long."
+ },
+ "intValue": {
+ "format": "int64",
+ "description": "A 64-bit signed integer.",
+ "type": "string"
+ }
+ },
+ "id": "AttributeValue"
+ },
+ "Attributes": {
+ "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
+ "type": "object",
+ "properties": {
+ "droppedAttributesCount": {
+ "format": "int32",
+ "description": "The number of attributes that were discarded. Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.",
+ "type": "integer"
+ },
+ "attributeMap": {
+ "additionalProperties": {
+ "$ref": "AttributeValue"
+ },
+ "description": "The set of attributes. Each attribute's key can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, an integer, or the\nBoolean values `true` and `false`. For example:\n\n \"/instance_id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes\": 300\n \"abc.com/myattribute\": true",
+ "type": "object"
+ }
+ },
+ "id": "Attributes"
+ }
+ },
+ "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"
}
diff --git a/container/v1/container-api.json b/container/v1/container-api.json
index c2b257b..3346c37 100644
--- a/container/v1/container-api.json
+++ b/container/v1/container-api.json
@@ -1,7 +1,4 @@
{
- "id": "container:v1",
- "documentationLink": "https://cloud.google.com/container-engine/",
- "revision": "20170804",
"title": "Google Container Engine API",
"ownerName": "Google",
"discoveryVersion": "v1",
@@ -11,18 +8,15 @@
"zones": {
"methods": {
"getServerconfig": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "id": "container.projects.zones.getServerconfig",
"description": "Returns configuration info about the Container Engine service.",
"httpMethod": "GET",
- "response": {
- "$ref": "ServerConfig"
- },
"parameterOrder": [
"projectId",
"zone"
],
+ "response": {
+ "$ref": "ServerConfig"
+ },
"parameters": {
"projectId": {
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
@@ -39,219 +33,16 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
+ "path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig"
}
},
"resources": {
"clusters": {
"methods": {
- "completeIpRotation": {
- "request": {
- "$ref": "CompleteIPRotationRequest"
- },
- "description": "Completes master IP rotation.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "type": "string",
- "required": true
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "id": "container.projects.zones.clusters.completeIpRotation",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation"
- },
- "setNetworkPolicy": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber)."
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "id": "container.projects.zones.clusters.setNetworkPolicy",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "description": "Enables/Disables Network Policy for a cluster.",
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- }
- },
- "legacyAbac": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
- },
- "clusterId": {
- "description": "The name of the cluster to update.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "id": "container.projects.zones.clusters.legacyAbac",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "description": "Enables or disables the ABAC authorization mechanism on a cluster."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Cluster"
- },
- "parameters": {
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "description": "The name of the cluster to retrieve.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.get",
- "description": "Gets the details of a specific cluster."
- },
- "startIpRotation": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
- "id": "container.projects.zones.clusters.startIpRotation",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
- "request": {
- "$ref": "StartIPRotationRequest"
- },
- "description": "Start master IP rotation."
- },
"addons": {
- "request": {
- "$ref": "SetAddonsConfigRequest"
- },
- "description": "Sets the addons of a specific cluster.",
"response": {
"$ref": "Operation"
},
@@ -272,24 +63,28 @@
"required": true
},
"zone": {
- "location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"clusterId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The name of the cluster to upgrade."
+ "description": "The name of the cluster to upgrade.",
+ "type": "string",
+ "required": true
}
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
"id": "container.projects.zones.clusters.addons",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons"
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ },
+ "description": "Sets the addons of a specific cluster."
},
"delete": {
- "httpMethod": "DELETE",
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
"response": {
"$ref": "Operation"
},
@@ -298,6 +93,10 @@
"zone",
"clusterId"
],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
"location": "path",
@@ -312,21 +111,20 @@
"required": true
},
"clusterId": {
- "location": "path",
"description": "The name of the cluster to delete.",
"type": "string",
- "required": true
+ "required": true,
+ "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.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."
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
},
"locations": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
+ "id": "container.projects.zones.clusters.locations",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
"request": {
"$ref": "SetLocationsRequest"
},
@@ -344,12 +142,6 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
"zone": {
"location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
@@ -361,60 +153,98 @@
"description": "The name of the cluster to upgrade.",
"type": "string",
"required": true
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
- "id": "container.projects.zones.clusters.locations",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations"
+ }
},
"update": {
- "httpMethod": "PUT",
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.update",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "description": "Updates the settings of a specific cluster.",
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "response": {
- "$ref": "Operation"
+ "httpMethod": "PUT",
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.update",
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "description": "Updates the settings of a specific cluster."
+ ]
},
"monitoring": {
"id": "container.projects.zones.clusters.monitoring",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
- "description": "Sets the monitoring service of a specific cluster.",
"request": {
"$ref": "SetMonitoringServiceRequest"
},
+ "description": "Sets the monitoring service of a specific cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring"
+ },
+ "master": {
"response": {
"$ref": "Operation"
},
@@ -432,10 +262,10 @@
"required": true
},
"zone": {
- "location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"clusterId": {
"location": "path",
@@ -447,9 +277,15 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring"
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
+ "id": "container.projects.zones.clusters.master",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
+ "description": "Updates the master of a specific cluster.",
+ "request": {
+ "$ref": "UpdateMasterRequest"
+ }
},
- "master": {
+ "setMasterAuth": {
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -459,9 +295,6 @@
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"clusterId": {
"type": "string",
@@ -476,62 +309,28 @@
"required": true
},
"zone": {
+ "location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
- "id": "container.projects.zones.clusters.master",
- "request": {
- "$ref": "UpdateMasterRequest"
- },
- "description": "Updates the master of a specific cluster."
- },
- "setMasterAuth": {
+ "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",
"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"
- },
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ }
},
"logging": {
+ "request": {
+ "$ref": "SetLoggingServiceRequest"
+ },
+ "description": "Sets the logging service of a specific cluster.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -558,21 +357,19 @@
"required": true
},
"clusterId": {
- "location": "path",
"description": "The name of the cluster to upgrade.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
- "id": "container.projects.zones.clusters.logging",
- "request": {
- "$ref": "SetLoggingServiceRequest"
- },
- "description": "Sets the logging service of a specific cluster."
+ "id": "container.projects.zones.clusters.logging"
},
"list": {
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListClustersResponse"
},
@@ -580,30 +377,34 @@
"projectId",
"zone"
],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones."
+ }
+ },
"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."
+ "id": "container.projects.zones.clusters.list"
},
"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"
+ },
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -613,9 +414,242 @@
"response": {
"$ref": "Operation"
},
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber)."
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "type": "string",
+ "required": true
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "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).",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.create",
+ "request": {
+ "$ref": "CreateClusterRequest"
+ },
+ "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster."
+ },
+ "completeIpRotation": {
+ "description": "Completes master IP rotation.",
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "id": "container.projects.zones.clusters.completeIpRotation"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to retrieve.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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.get",
+ "description": "Gets the details of a specific cluster."
+ },
+ "setNetworkPolicy": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "id": "container.projects.zones.clusters.setNetworkPolicy",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "description": "Enables/Disables Network Policy for a cluster."
+ },
+ "legacyAbac": {
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to update.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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"
+ },
+ "startIpRotation": {
+ "id": "container.projects.zones.clusters.startIpRotation",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "description": "Start master IP rotation.",
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"projectId": {
"location": "path",
@@ -630,136 +664,22 @@
"location": "path"
},
"clusterId": {
- "location": "path",
"description": "The name of the cluster.",
"type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "id": "container.projects.zones.clusters.resourceLabels",
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "description": "Sets labels on a cluster."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.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"
- }
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation"
}
},
"resources": {
"nodePools": {
"methods": {
- "autoscaling": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.",
- "type": "string",
- "required": true
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to upgrade.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
- "id": "container.projects.zones.clusters.nodePools.autoscaling",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
- "description": "Sets the autoscaling settings of a specific node pool.",
- "request": {
- "$ref": "SetNodePoolAutoscalingRequest"
- }
- },
"get": {
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the cluster."
- },
- "nodePoolId": {
- "description": "The name of the node pool.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
"id": "container.projects.zones.clusters.nodePools.get",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
@@ -773,69 +693,22 @@
"clusterId",
"nodePoolId"
],
- "httpMethod": "GET"
- },
- "update": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.",
- "type": "string",
- "required": true
- },
- "nodePoolId": {
- "description": "The name of the node pool to upgrade.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
- "id": "container.projects.zones.clusters.nodePools.update",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
- "description": "Updates the version and/or image type of a specific node pool.",
- "request": {
- "$ref": "UpdateNodePoolRequest"
- }
- },
- "delete": {
"parameters": {
"projectId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber)."
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "type": "string",
+ "required": true
},
"zone": {
+ "location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"clusterId": {
"description": "The name of the cluster.",
@@ -844,77 +717,60 @@
"location": "path"
},
"nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to delete.",
+ "description": "The name of the node pool.",
"type": "string",
- "required": true
+ "required": true,
+ "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",
- "description": "Deletes a node pool from a cluster.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
}
},
- "setManagement": {
- "response": {
- "$ref": "Operation"
+ "update": {
+ "request": {
+ "$ref": "UpdateNodePoolRequest"
},
+ "description": "Updates the version and/or image type of a specific node pool.",
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId",
"nodePoolId"
],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to update.",
- "type": "string",
- "required": true
- },
- "nodePoolId": {
- "description": "The name of the node pool to update.",
- "type": "string",
- "required": true,
- "location": "path"
- }
+ "response": {
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "id": "container.projects.zones.clusters.nodePools.setManagement",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "description": "Sets the NodeManagement options for a node pool.",
- "request": {
- "$ref": "SetNodePoolManagementRequest"
- }
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the cluster to upgrade."
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to upgrade.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
+ "id": "container.projects.zones.clusters.nodePools.update"
},
"setSize": {
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
@@ -954,38 +810,51 @@
"location": "path"
},
"nodePoolId": {
- "location": "path",
"description": "The name of the node pool to update.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "list": {
- "httpMethod": "GET",
+ "delete": {
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.delete",
+ "description": "Deletes a node pool from a cluster.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"projectId",
"zone",
- "clusterId"
+ "clusterId",
+ "nodePoolId"
],
"response": {
- "$ref": "ListNodePoolsResponse"
+ "$ref": "Operation"
},
+ "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.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"clusterId": {
+ "location": "path",
"description": "The name of the cluster.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to delete.",
+ "type": "string",
+ "required": true
},
"projectId": {
"location": "path",
@@ -994,15 +863,13 @@
"required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.list",
- "description": "Lists the node pools for a cluster."
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}"
},
- "rollback": {
+ "setManagement": {
+ "description": "Sets the NodeManagement options for a node pool.",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ },
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -1014,18 +881,6 @@
"$ref": "Operation"
},
"parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to rollback.",
- "type": "string",
- "required": true
- },
- "nodePoolId": {
- "description": "The name of the node pool to rollback.",
- "type": "string",
- "required": true,
- "location": "path"
- },
"projectId": {
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"type": "string",
@@ -1033,22 +888,116 @@
"location": "path"
},
"zone": {
- "location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to update.",
+ "type": "string",
+ "required": true
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "id": "container.projects.zones.clusters.nodePools.setManagement"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.list",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "description": "Lists the node pools for a cluster."
+ },
+ "rollback": {
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ "id": "container.projects.zones.clusters.nodePools.rollback",
+ "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ "request": {
+ "$ref": "RollbackNodePoolUpgradeRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the cluster to rollback."
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to rollback.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
"required": true
}
},
"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",
- "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
- "request": {
- "$ref": "RollbackNodePoolUpgradeRequest"
- }
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback"
},
"create": {
"request": {
@@ -1069,27 +1018,75 @@
],
"parameters": {
"projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "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.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"clusterId": {
- "location": "path",
"description": "The name of the cluster.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
"id": "container.projects.zones.clusters.nodePools.create"
+ },
+ "autoscaling": {
+ "description": "Sets the autoscaling settings of a specific node pool.",
+ "request": {
+ "$ref": "SetNodePoolAutoscalingRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.",
+ "type": "string",
+ "required": true
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to upgrade.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
+ "id": "container.projects.zones.clusters.nodePools.autoscaling",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling"
}
}
}
@@ -1097,47 +1094,6 @@
},
"operations": {
"methods": {
- "cancel": {
- "description": "Cancels the specified operation.",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.",
- "type": "string",
- "required": true
- },
- "operationId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The server-assigned `name` of the operation."
- }
- },
- "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"
- },
"get": {
"httpMethod": "GET",
"parameterOrder": [
@@ -1148,10 +1104,13 @@
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
"projectId": {
"location": "path",
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
@@ -1163,21 +1122,21 @@
"type": "string",
"required": true,
"location": "path"
- },
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.",
- "type": "string",
- "required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
"path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
"id": "container.projects.zones.operations.get",
"description": "Gets the specified operation."
},
"list": {
+ "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.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListOperationsResponse"
},
@@ -1185,7 +1144,6 @@
"projectId",
"zone"
],
- "httpMethod": "GET",
"parameters": {
"projectId": {
"location": "path",
@@ -1194,18 +1152,57 @@
"required": true
},
"zone": {
+ "location": "path",
"description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
- "id": "container.projects.zones.operations.list",
- "path": "v1/projects/{projectId}/zones/{zone}/operations"
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations"
+ },
+ "cancel": {
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "id": "container.projects.zones.operations.cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Cancels the specified operation.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.",
+ "type": "string",
+ "required": true
+ },
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel"
}
}
}
@@ -1215,81 +1212,16 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"bearer_token": {
"location": "query",
@@ -1300,33 +1232,90 @@
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "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": {
+ "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"
}
},
"schemas": {
- "NodeManagement": {
- "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
- "type": "object",
- "properties": {
- "autoRepair": {
- "type": "boolean",
- "description": "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered."
- },
- "autoUpgrade": {
- "description": "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
- "type": "boolean"
- },
- "upgradeOptions": {
- "description": "Specifies the Auto Upgrade knobs for the node pool.",
- "$ref": "AutoUpgradeOptions"
- }
- },
- "id": "NodeManagement"
- },
"CancelOperationRequest": {
+ "id": "CancelOperationRequest",
"description": "CancelOperationRequest cancels a single operation.",
"type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
+ "properties": {}
+ },
+ "KubernetesDashboard": {
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
+ "type": "boolean"
+ }
+ },
+ "id": "KubernetesDashboard",
+ "description": "Configuration for the Kubernetes Dashboard."
},
"SetLegacyAbacRequest": {
"description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
@@ -1339,21 +1328,31 @@
},
"id": "SetLegacyAbacRequest"
},
- "KubernetesDashboard": {
- "properties": {
- "disabled": {
- "description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
- "type": "boolean"
- }
- },
- "id": "KubernetesDashboard",
- "description": "Configuration for the Kubernetes Dashboard.",
- "type": "object"
- },
"Operation": {
- "type": "object",
"properties": {
+ "name": {
+ "description": "The server-assigned ID for the operation.",
+ "type": "string"
+ },
+ "statusMessage": {
+ "type": "string",
+ "description": "If an error has occurred, a textual description of the error."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "Server-defined URL for the resource."
+ },
+ "detail": {
+ "description": "Detailed operation progress, if available.",
+ "type": "string"
+ },
+ "targetLink": {
+ "description": "Server-defined URL for the target of the operation.",
+ "type": "string"
+ },
"operationType": {
+ "description": "The operation type.",
+ "type": "string",
"enumDescriptions": [
"Not set.",
"Cluster create.",
@@ -1389,9 +1388,7 @@
"SET_MASTER_AUTH",
"SET_NODE_POOL_SIZE",
"SET_NETWORK_POLICY"
- ],
- "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.",
@@ -1414,39 +1411,17 @@
],
"description": "The current status of the operation.",
"type": "string"
- },
- "statusMessage": {
- "description": "If an error has occurred, a textual description of the error.",
- "type": "string"
- },
- "name": {
- "description": "The server-assigned ID for the operation.",
- "type": "string"
- },
- "selfLink": {
- "description": "Server-defined URL for the resource.",
- "type": "string"
- },
- "detail": {
- "description": "Detailed operation progress, if available.",
- "type": "string"
- },
- "targetLink": {
- "description": "Server-defined URL for the target of the operation.",
- "type": "string"
}
},
"id": "Operation",
- "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only."
+ "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
+ "type": "object"
},
"AddonsConfig": {
+ "id": "AddonsConfig",
"description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.",
"type": "object",
"properties": {
- "kubernetesDashboard": {
- "$ref": "KubernetesDashboard",
- "description": "Configuration for the Kubernetes Dashboard."
- },
"horizontalPodAutoscaling": {
"$ref": "HorizontalPodAutoscaling",
"description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods."
@@ -1454,12 +1429,14 @@
"httpLoadBalancing": {
"$ref": "HttpLoadBalancing",
"description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster."
+ },
+ "kubernetesDashboard": {
+ "$ref": "KubernetesDashboard",
+ "description": "Configuration for the Kubernetes Dashboard."
}
- },
- "id": "AddonsConfig"
+ }
},
"SetLocationsRequest": {
- "description": "SetLocationsRequest sets the locations of the cluster.",
"type": "object",
"properties": {
"locations": {
@@ -1470,27 +1447,29 @@
"type": "array"
}
},
- "id": "SetLocationsRequest"
+ "id": "SetLocationsRequest",
+ "description": "SetLocationsRequest sets the locations of the cluster."
},
"RollbackNodePoolUpgradeRequest": {
- "properties": {},
- "id": "RollbackNodePoolUpgradeRequest",
"description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "RollbackNodePoolUpgradeRequest"
},
"SetNodePoolSizeRequest": {
"description": "SetNodePoolSizeRequest sets the size a node\npool.",
"type": "object",
"properties": {
"nodeCount": {
- "type": "integer",
"format": "int32",
- "description": "The desired node count for the pool."
+ "description": "The desired node count for the pool.",
+ "type": "integer"
}
},
"id": "SetNodePoolSizeRequest"
},
"UpdateClusterRequest": {
+ "type": "object",
"properties": {
"update": {
"$ref": "ClusterUpdate",
@@ -1498,15 +1477,12 @@
}
},
"id": "UpdateClusterRequest",
- "description": "UpdateClusterRequest updates the settings of a cluster.",
- "type": "object"
+ "description": "UpdateClusterRequest updates the settings of a cluster."
},
"NetworkPolicy": {
+ "description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
+ "type": "object",
"properties": {
- "enabled": {
- "description": "Whether network policy is enabled on the cluster.",
- "type": "boolean"
- },
"provider": {
"description": "The selected network policy provider.",
"type": "string",
@@ -1518,11 +1494,13 @@
"PROVIDER_UNSPECIFIED",
"CALICO"
]
+ },
+ "enabled": {
+ "description": "Whether network policy is enabled on the cluster.",
+ "type": "boolean"
}
},
- "id": "NetworkPolicy",
- "description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
- "type": "object"
+ "id": "NetworkPolicy"
},
"UpdateMasterRequest": {
"type": "object",
@@ -1539,72 +1517,34 @@
"description": "A Google Container Engine cluster.",
"type": "object",
"properties": {
- "createTime": {
- "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
- "clusterIpv4Cidr": {
- "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.",
- "type": "string"
- },
- "initialNodeCount": {
- "format": "int32",
- "description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.",
- "type": "integer"
- },
- "locations": {
- "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "selfLink": {
- "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.",
- "items": {
- "$ref": "NodePool"
- },
- "type": "array"
- },
- "instanceGroupUrls": {
- "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\ncluster.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "networkPolicy": {
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
},
"servicesIpv4Cidr": {
"description": "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.",
"type": "string"
},
- "networkPolicy": {
- "$ref": "NetworkPolicy",
- "description": "Configuration options for the NetworkPolicy feature."
- },
"enableKubernetesAlpha": {
- "type": "boolean",
- "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1alpha1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation."
+ "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1alpha1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.",
+ "type": "boolean"
},
"description": {
"description": "An optional description of this cluster.",
"type": "string"
},
"currentNodeCount": {
+ "type": "integer",
"format": "int32",
- "description": "[Output only] The number of nodes currently in the cluster.",
- "type": "integer"
+ "description": "[Output only] The number of nodes currently in the cluster."
},
"monitoringService": {
"description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* `monitoring.googleapis.com` - the Google Cloud Monitoring service.\n* `none` - no metrics will be exported from the cluster.\n* if left as an empty string, `monitoring.googleapis.com` will be used.",
"type": "string"
},
"network": {
- "type": "string",
- "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used."
+ "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
+ "type": "string"
},
"labelFingerprint": {
"description": "The fingerprint of the set of labels for this cluster.",
@@ -1614,15 +1554,15 @@
"description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string"
},
- "expireTime": {
- "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
"nodeIpv4CidrSize": {
"format": "int32",
"description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange.",
"type": "integer"
},
+ "expireTime": {
+ "type": "string",
+ "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
+ },
"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"
@@ -1644,22 +1584,14 @@
"type": "string"
},
"nodeConfig": {
- "$ref": "NodeConfig",
- "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used."
+ "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used.",
+ "$ref": "NodeConfig"
},
"addonsConfig": {
"description": "Configurations for the various addons available to run in the cluster.",
"$ref": "AddonsConfig"
},
"status": {
- "enumDescriptions": [
- "Not set.",
- "The PROVISIONING state indicates the cluster is being created.",
- "The RUNNING state indicates the cluster has been created and is fully\nusable.",
- "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.",
- "The STOPPING state indicates the cluster is being deleted.",
- "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field."
- ],
"enum": [
"STATUS_UNSPECIFIED",
"PROVISIONING",
@@ -1669,18 +1601,22 @@
"ERROR"
],
"description": "[Output only] The current status of this cluster.",
- "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"
+ "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."
+ ]
},
"subnetwork": {
"description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.",
"type": "string"
},
- "name": {
- "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
+ "currentNodeVersion": {
+ "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
"type": "string"
},
"resourceLabels": {
@@ -1690,45 +1626,66 @@
"description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.",
"type": "object"
},
+ "name": {
+ "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
+ "type": "string"
+ },
"initialClusterVersion": {
"description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
"type": "string"
},
"ipAllocationPolicy": {
- "$ref": "IPAllocationPolicy",
- "description": "Configuration for cluster IP allocation."
+ "description": "Configuration for cluster IP allocation.",
+ "$ref": "IPAllocationPolicy"
+ },
+ "endpoint": {
+ "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
+ "type": "string"
},
"legacyAbac": {
"$ref": "LegacyAbac",
"description": "Configuration for the legacy ABAC authorization mode."
},
- "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.",
+ "createTime": {
+ "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
- }
- },
- "id": "Cluster"
- },
- "ListOperationsResponse": {
- "description": "ListOperationsResponse is the result of ListOperationsRequest.",
- "type": "object",
- "properties": {
- "missingZones": {
- "description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones.",
+ },
+ "clusterIpv4Cidr": {
+ "type": "string",
+ "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`."
+ },
+ "initialNodeCount": {
+ "format": "int32",
+ "description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.",
+ "type": "integer"
+ },
+ "nodePools": {
+ "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.",
+ "items": {
+ "$ref": "NodePool"
+ },
+ "type": "array"
+ },
+ "locations": {
+ "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.",
"items": {
"type": "string"
},
"type": "array"
},
- "operations": {
- "description": "A list of operations in the project in the specified zone.",
+ "selfLink": {
+ "description": "[Output only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "instanceGroupUrls": {
+ "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\ncluster.",
"items": {
- "$ref": "Operation"
+ "type": "string"
},
"type": "array"
}
},
- "id": "ListOperationsResponse"
+ "id": "Cluster"
},
"CreateNodePoolRequest": {
"description": "CreateNodePoolRequest creates a node pool for a cluster.",
@@ -1741,18 +1698,40 @@
},
"id": "CreateNodePoolRequest"
},
- "SetMonitoringServiceRequest": {
- "description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.",
+ "ListOperationsResponse": {
+ "description": "ListOperationsResponse is the result of ListOperationsRequest.",
"type": "object",
"properties": {
+ "operations": {
+ "description": "A list of operations in the project in the specified zone.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ },
+ "missingZones": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones."
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "SetMonitoringServiceRequest": {
+ "properties": {
"monitoringService": {
"description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
"type": "string"
}
},
- "id": "SetMonitoringServiceRequest"
+ "id": "SetMonitoringServiceRequest",
+ "description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.",
+ "type": "object"
},
"CidrBlock": {
+ "id": "CidrBlock",
"description": "CidrBlock contains an optional name and one CIDR block.",
"type": "object",
"properties": {
@@ -1764,8 +1743,7 @@
"description": "cidr_block must be specified in CIDR notation.",
"type": "string"
}
- },
- "id": "CidrBlock"
+ }
},
"ServerConfig": {
"description": "Container Engine service configuration.",
@@ -1787,11 +1765,11 @@
"type": "string"
},
"validImageTypes": {
- "description": "List of valid image types.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "List of valid image types."
},
"validNodeVersions": {
"description": "List of valid node upgrade target versions.",
@@ -1804,8 +1782,31 @@
"id": "ServerConfig"
},
"NodeConfig": {
+ "description": "Parameters that describe the nodes in a cluster.",
"type": "object",
"properties": {
+ "imageType": {
+ "description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
+ "type": "string"
+ },
+ "oauthScopes": {
+ "description": "The set of Google API scopes to be made available on all of the\nnode VMs under the \"default\" service account.\n\nThe following scopes are recommended, but not required, and by default are\nnot included:\n\n* `https://www.googleapis.com/auth/compute` is required for mounting\npersistent storage on your nodes.\n* `https://www.googleapis.com/auth/devstorage.read_only` is required for\ncommunicating with **gcr.io**\n(the [Google Container Registry](/container-registry/)).\n\nIf unspecified, no scopes are added, unless Cloud Logging or Cloud\nMonitoring are enabled, in which case their required scopes will be added.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "preemptible": {
+ "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninformation about preemptible VM instances.",
+ "type": "boolean"
+ },
+ "labels": {
+ "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": {
"format": "int32",
"description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.",
@@ -1831,45 +1832,22 @@
"type": "array"
},
"serviceAccount": {
- "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.",
- "type": "string"
+ "type": "string",
+ "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used."
},
"accelerators": {
- "description": "A list of hardware accelerators to be attached to each node.\nSee https://cloud.google.com/compute/docs/gpus for more information about\nsupport for GPUs.",
"items": {
"$ref": "AcceleratorConfig"
},
- "type": "array"
+ "type": "array",
+ "description": "A list of hardware accelerators to be attached to each node.\nSee https://cloud.google.com/compute/docs/gpus for more information about\nsupport for GPUs."
},
"machineType": {
"description": "The name of a Google Compute Engine [machine\ntype](/compute/docs/machine-types) (e.g.\n`n1-standard-1`).\n\nIf unspecified, the default machine type is\n`n1-standard-1`.",
"type": "string"
- },
- "imageType": {
- "type": "string",
- "description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used."
- },
- "oauthScopes": {
- "description": "The set of Google API scopes to be made available on all of the\nnode VMs under the \"default\" service account.\n\nThe following scopes are recommended, but not required, and by default are\nnot included:\n\n* `https://www.googleapis.com/auth/compute` is required for mounting\npersistent storage on your nodes.\n* `https://www.googleapis.com/auth/devstorage.read_only` is required for\ncommunicating with **gcr.io**\n(the [Google Container Registry](/container-registry/)).\n\nIf unspecified, no scopes are added, unless Cloud Logging or Cloud\nMonitoring are enabled, in which case their required scopes will be added.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "preemptible": {
- "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninformation about preemptible VM instances.",
- "type": "boolean"
- },
- "labels": {
- "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"
}
},
- "id": "NodeConfig",
- "description": "Parameters that describe the nodes in a cluster."
+ "id": "NodeConfig"
},
"MasterAuth": {
"id": "MasterAuth",
@@ -1897,46 +1875,46 @@
"type": "string"
},
"username": {
- "description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
- "type": "string"
+ "type": "string",
+ "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."
}
}
},
"AutoUpgradeOptions": {
- "id": "AutoUpgradeOptions",
"description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
"type": "object",
"properties": {
"description": {
- "type": "string",
- "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade."
+ "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"clusters": {
"description": "A list of clusters in the project in the specified zone, or\nacross all ones.",
"items": {
"$ref": "Cluster"
},
"type": "array"
+ },
+ "missingZones": {
+ "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "ListClustersResponse",
- "description": "ListClustersResponse is the result of ListClustersRequest.",
- "type": "object"
+ "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.",
@@ -1950,27 +1928,28 @@
"id": "HttpLoadBalancing"
},
"NodePoolAutoscaling": {
- "id": "NodePoolAutoscaling",
"description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
"type": "object",
"properties": {
- "maxNodeCount": {
- "format": "int32",
- "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
- "type": "integer"
- },
"minNodeCount": {
"format": "int32",
"description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
"type": "integer"
},
"enabled": {
- "type": "boolean",
- "description": "Is autoscaling enabled for this node pool."
+ "description": "Is autoscaling enabled for this node pool.",
+ "type": "boolean"
+ },
+ "maxNodeCount": {
+ "format": "int32",
+ "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
+ "type": "integer"
}
- }
+ },
+ "id": "NodePoolAutoscaling"
},
"ClientCertificateConfig": {
+ "id": "ClientCertificateConfig",
"description": "Configuration for client certificates on the cluster.",
"type": "object",
"properties": {
@@ -1978,11 +1957,16 @@
"description": "Issue a client certificate.",
"type": "boolean"
}
- },
- "id": "ClientCertificateConfig"
+ }
},
"SetMasterAuthRequest": {
+ "description": "SetMasterAuthRequest updates the admin password of a cluster.",
+ "type": "object",
"properties": {
+ "update": {
+ "description": "A description of the update.",
+ "$ref": "MasterAuth"
+ },
"action": {
"enumDescriptions": [
"Operation is unknown and will error out",
@@ -1996,15 +1980,9 @@
],
"description": "The exact form of action to be taken on the master auth",
"type": "string"
- },
- "update": {
- "description": "A description of the update.",
- "$ref": "MasterAuth"
}
},
- "id": "SetMasterAuthRequest",
- "description": "SetMasterAuthRequest updates the admin password of a cluster.",
- "type": "object"
+ "id": "SetMasterAuthRequest"
},
"SetNetworkPolicyRequest": {
"description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
@@ -2017,41 +1995,34 @@
},
"id": "SetNetworkPolicyRequest"
},
- "IPAllocationPolicy": {
- "description": "Configuration for controlling how IPs are allocated in the cluster.",
- "type": "object",
- "properties": {
- "useIpAliases": {
- "description": "Whether alias IPs will be used for pod IPs in the cluster.",
- "type": "boolean"
- },
- "createSubnetwork": {
- "type": "boolean",
- "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true."
- },
- "subnetworkName": {
- "description": "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork.",
- "type": "string"
- },
- "clusterIpv4Cidr": {
- "type": "string",
- "description": "The IP address range for the cluster pod IPs. If this field is set, then\n`cluster.cluster_ipv4_cidr` must be left blank.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range will be chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range be chosen with a specific\nnetmask.\n\nSet to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use."
- },
- "nodeIpv4Cidr": {
- "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range will be chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range be chosen with a specific\nnetmask.\n\nSet to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
- "type": "string"
- },
- "servicesIpv4Cidr": {
- "type": "string",
- "description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range will be chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range be chosen with a specific\nnetmask.\n\nSet to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use."
- }
- },
- "id": "IPAllocationPolicy"
- },
"ClusterUpdate": {
+ "id": "ClusterUpdate",
"description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.",
"type": "object",
"properties": {
+ "desiredLocations": {
+ "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "desiredNodePoolAutoscaling": {
+ "$ref": "NodePoolAutoscaling",
+ "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool."
+ },
+ "desiredMonitoringService": {
+ "type": "string",
+ "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster"
+ },
+ "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"
@@ -2065,45 +2036,52 @@
"type": "string"
},
"desiredMasterAuthorizedNetworksConfig": {
- "$ref": "MasterAuthorizedNetworksConfig",
- "description": "Master authorized networks is a Beta feature.\nThe desired configuration options for master authorized networks feature."
- },
- "desiredLocations": {
- "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "desiredNodePoolAutoscaling": {
- "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": {
- "type": "string",
- "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster"
- },
- "desiredImageType": {
- "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
+ "description": "Master authorized networks is a Beta feature.\nThe desired configuration options for master authorized networks feature.",
+ "$ref": "MasterAuthorizedNetworksConfig"
+ }
+ }
+ },
+ "IPAllocationPolicy": {
+ "description": "Configuration for controlling how IPs are allocated in the cluster.",
+ "type": "object",
+ "properties": {
+ "servicesIpv4Cidr": {
+ "description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range will be chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range be chosen with a specific\nnetmask.\n\nSet to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
"type": "string"
},
- "desiredAddonsConfig": {
- "$ref": "AddonsConfig",
- "description": "Configurations for the various addons available to run in the cluster."
+ "useIpAliases": {
+ "description": "Whether alias IPs will be used for pod IPs in the cluster.",
+ "type": "boolean"
+ },
+ "createSubnetwork": {
+ "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.",
+ "type": "boolean"
+ },
+ "subnetworkName": {
+ "description": "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork.",
+ "type": "string"
+ },
+ "clusterIpv4Cidr": {
+ "description": "The IP address range for the cluster pod IPs. If this field is set, then\n`cluster.cluster_ipv4_cidr` must be left blank.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range will be chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range be chosen with a specific\nnetmask.\n\nSet to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
+ "type": "string"
+ },
+ "nodeIpv4Cidr": {
+ "type": "string",
+ "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range will be chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range be chosen with a specific\nnetmask.\n\nSet to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use."
}
},
- "id": "ClusterUpdate"
+ "id": "IPAllocationPolicy"
},
"SetLoggingServiceRequest": {
- "id": "SetLoggingServiceRequest",
- "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
- "type": "object",
"properties": {
"loggingService": {
"type": "string",
"description": "The logging service the cluster should use to write metrics.\nCurrently available options:\n\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no metrics will be exported from the cluster"
}
- }
+ },
+ "id": "SetLoggingServiceRequest",
+ "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
+ "type": "object"
},
"HorizontalPodAutoscaling": {
"description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
@@ -2116,18 +2094,13 @@
},
"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"
- },
"MasterAuthorizedNetworksConfig": {
+ "description": "Master authorized networks is a Beta feature.\nConfiguration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.",
"type": "object",
"properties": {
"enabled": {
- "type": "boolean",
- "description": "Whether or not master authorized networks is enabled."
+ "description": "Whether or not master authorized networks is enabled.",
+ "type": "boolean"
},
"cidrBlocks": {
"description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
@@ -2137,8 +2110,7 @@
"type": "array"
}
},
- "id": "MasterAuthorizedNetworksConfig",
- "description": "Master authorized networks is a Beta feature.\nConfiguration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs."
+ "id": "MasterAuthorizedNetworksConfig"
},
"SetNodePoolManagementRequest": {
"description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
@@ -2151,24 +2123,30 @@
},
"id": "SetNodePoolManagementRequest"
},
+ "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": {}
+ },
"SetNodePoolAutoscalingRequest": {
+ "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
+ "type": "object",
"properties": {
"autoscaling": {
"$ref": "NodePoolAutoscaling",
"description": "Autoscaling configuration for the node pool."
}
},
- "id": "SetNodePoolAutoscalingRequest",
- "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
- "type": "object"
+ "id": "SetNodePoolAutoscalingRequest"
},
"CreateClusterRequest": {
"description": "CreateClusterRequest creates a cluster.",
"type": "object",
"properties": {
"cluster": {
- "$ref": "Cluster",
- "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)"
+ "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)",
+ "$ref": "Cluster"
}
},
"id": "CreateClusterRequest"
@@ -2200,6 +2178,7 @@
"id": "StartIPRotationRequest"
},
"UpdateNodePoolRequest": {
+ "type": "object",
"properties": {
"nodeVersion": {
"description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
@@ -2211,15 +2190,15 @@
}
},
"id": "UpdateNodePoolRequest",
- "description": "UpdateNodePoolRequests update a node pool's image and/or version.",
- "type": "object"
+ "description": "UpdateNodePoolRequests update a node pool's image and/or version."
},
"AcceleratorConfig": {
+ "description": "AcceleratorConfig represents a Hardware Accelerator request.",
"type": "object",
"properties": {
"acceleratorType": {
- "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)",
- "type": "string"
+ "type": "string",
+ "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)"
},
"acceleratorCount": {
"format": "int64",
@@ -2227,19 +2206,18 @@
"type": "string"
}
},
- "id": "AcceleratorConfig",
- "description": "AcceleratorConfig represents a Hardware Accelerator request."
+ "id": "AcceleratorConfig"
},
"LegacyAbac": {
+ "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.",
+ "type": "object",
"properties": {
"enabled": {
"description": "Whether the ABAC authorizer is enabled for this cluster. When enabled,\nidentities in the system, including service accounts, nodes, and\ncontrollers, will have statically granted permissions beyond those\nprovided by the RBAC configuration or IAM.",
"type": "boolean"
}
},
- "id": "LegacyAbac",
- "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.",
- "type": "object"
+ "id": "LegacyAbac"
},
"SetAddonsConfigRequest": {
"description": "SetAddonsConfigRequest sets the addons associated with the cluster.",
@@ -2252,13 +2230,29 @@
},
"id": "SetAddonsConfigRequest"
},
+ "SetLabelsRequest": {
+ "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster",
+ "type": "object",
+ "properties": {
+ "resourceLabels": {
+ "description": "The labels to set for that cluster.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "labelFingerprint": {
+ "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
+ "type": "string"
+ }
+ },
+ "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": {
- "description": "[Output only] The status of the nodes in this pool instance.",
- "type": "string",
"enumDescriptions": [
"Not set.",
"The PROVISIONING state indicates the node pool is being created.",
@@ -2276,7 +2270,9 @@
"RECONCILING",
"STOPPING",
"ERROR"
- ]
+ ],
+ "description": "[Output only] The status of the nodes in this pool instance.",
+ "type": "string"
},
"config": {
"$ref": "NodeConfig",
@@ -2294,15 +2290,15 @@
"$ref": "NodePoolAutoscaling",
"description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present."
},
+ "initialNodeCount": {
+ "format": "int32",
+ "description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.",
+ "type": "integer"
+ },
"management": {
"$ref": "NodeManagement",
"description": "NodeManagement configuration for this NodePool."
},
- "initialNodeCount": {
- "type": "integer",
- "format": "int32",
- "description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota."
- },
"selfLink": {
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
@@ -2321,28 +2317,29 @@
},
"id": "NodePool"
},
- "SetLabelsRequest": {
- "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster",
+ "NodeManagement": {
+ "id": "NodeManagement",
+ "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
"type": "object",
"properties": {
- "resourceLabels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels to set for that cluster.",
- "type": "object"
+ "autoRepair": {
+ "description": "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered.",
+ "type": "boolean"
},
- "labelFingerprint": {
- "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
- "type": "string"
+ "autoUpgrade": {
+ "description": "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
+ "type": "boolean"
+ },
+ "upgradeOptions": {
+ "description": "Specifies the Auto Upgrade knobs for the node pool.",
+ "$ref": "AutoUpgradeOptions"
}
- },
- "id": "SetLabelsRequest"
+ }
}
},
"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",
@@ -2364,5 +2361,8 @@
"basePath": "",
"ownerDomain": "google.com",
"name": "container",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "id": "container:v1",
+ "documentationLink": "https://cloud.google.com/container-engine/",
+ "revision": "20170814"
}
diff --git a/container/v1beta1/container-api.json b/container/v1beta1/container-api.json
index 08cd9b9..70ad9d4 100644
--- a/container/v1beta1/container-api.json
+++ b/container/v1beta1/container-api.json
@@ -1,7 +1,2862 @@
{
- "error": {
- "code": 404,
- "message": "Discovery document not found for API service: container.googleapis.com format: rest version: v1beta1",
- "status": "NOT_FOUND"
- }
+ "version_module": true,
+ "schemas": {
+ "AcceleratorConfig": {
+ "description": "AcceleratorConfig represents a Hardware Accelerator request.",
+ "type": "object",
+ "properties": {
+ "acceleratorType": {
+ "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)",
+ "type": "string"
+ },
+ "acceleratorCount": {
+ "type": "string",
+ "format": "int64",
+ "description": "The number of the accelerator cards exposed to an instance."
+ }
+ },
+ "id": "AcceleratorConfig"
+ },
+ "NodePool": {
+ "description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "RUNNING",
+ "RUNNING_WITH_ERROR",
+ "RECONCILING",
+ "STOPPING",
+ "ERROR"
+ ],
+ "description": "[Output only] The status of the nodes in this pool instance.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not set.",
+ "The PROVISIONING state indicates the node pool is being created.",
+ "The RUNNING state indicates the node pool has been created\nand is fully usable.",
+ "The RUNNING_WITH_ERROR state indicates the node pool has been created\nand is partially usable. Some error state has occurred and some\nfunctionality may be impaired. Customer may need to reissue a request\nor trigger a new update.",
+ "The RECONCILING state indicates that some work is actively being done on\nthe node pool, such as upgrading node software. Details can\nbe found in the `statusMessage` field.",
+ "The STOPPING state indicates the node pool is being deleted.",
+ "The ERROR state indicates the node pool may be unusable. Details\ncan be found in the `statusMessage` field."
+ ]
+ },
+ "config": {
+ "description": "The node configuration of the pool.",
+ "$ref": "NodeConfig"
+ },
+ "statusMessage": {
+ "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the node pool.",
+ "type": "string"
+ },
+ "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": {
+ "format": "int32",
+ "description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.",
+ "type": "integer"
+ },
+ "selfLink": {
+ "description": "[Output only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "instanceGroupUrls": {
+ "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\nnode pool.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "version": {
+ "type": "string",
+ "description": "[Output only] The version of the Kubernetes of this node."
+ }
+ },
+ "id": "NodePool"
+ },
+ "SetLabelsRequest": {
+ "id": "SetLabelsRequest",
+ "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster",
+ "type": "object",
+ "properties": {
+ "labelFingerprint": {
+ "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "resourceLabels": {
+ "description": "The labels to set for that cluster.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "projectId": {
+ "type": "string",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead."
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ }
+ },
+ "NodeManagement": {
+ "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
+ "type": "object",
+ "properties": {
+ "autoRepair": {
+ "description": "Whether the nodes will be automatically repaired.",
+ "type": "boolean"
+ },
+ "autoUpgrade": {
+ "description": "Whether the nodes will be automatically upgraded.",
+ "type": "boolean"
+ },
+ "upgradeOptions": {
+ "description": "Specifies the Auto Upgrade knobs for the node pool.",
+ "$ref": "AutoUpgradeOptions"
+ }
+ },
+ "id": "NodeManagement"
+ },
+ "CancelOperationRequest": {
+ "description": "CancelOperationRequest cancels a single operation.",
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string"
+ }
+ },
+ "id": "CancelOperationRequest"
+ },
+ "SetLegacyAbacRequest": {
+ "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "enabled": {
+ "description": "Whether ABAC authorization will be enabled in the cluster.",
+ "type": "boolean"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead."
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "SetLegacyAbacRequest"
+ },
+ "KubernetesDashboard": {
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
+ "type": "boolean"
+ }
+ },
+ "id": "KubernetesDashboard",
+ "description": "Configuration for the Kubernetes Dashboard."
+ },
+ "Operation": {
+ "id": "Operation",
+ "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "type": "string",
+ "description": "Server-defined URL for the resource."
+ },
+ "location": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.",
+ "type": "string"
+ },
+ "targetLink": {
+ "description": "Server-defined URL for the target of the operation.",
+ "type": "string"
+ },
+ "detail": {
+ "description": "Detailed operation progress, if available.",
+ "type": "string"
+ },
+ "operationType": {
+ "enumDescriptions": [
+ "Not set.",
+ "Cluster create.",
+ "Cluster delete.",
+ "A master upgrade.",
+ "A node upgrade.",
+ "Cluster repair.",
+ "Cluster update.",
+ "Node pool create.",
+ "Node pool delete.",
+ "Set node pool management.",
+ "Automatic node pool repair.",
+ "Automatic node upgrade.",
+ "Set labels.",
+ "Set/generate master auth materials",
+ "Set node pool size.",
+ "Updates network policy for a cluster."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CREATE_CLUSTER",
+ "DELETE_CLUSTER",
+ "UPGRADE_MASTER",
+ "UPGRADE_NODES",
+ "REPAIR_CLUSTER",
+ "UPDATE_CLUSTER",
+ "CREATE_NODE_POOL",
+ "DELETE_NODE_POOL",
+ "SET_NODE_POOL_MANAGEMENT",
+ "AUTO_REPAIR_NODES",
+ "AUTO_UPGRADE_NODES",
+ "SET_LABELS",
+ "SET_MASTER_AUTH",
+ "SET_NODE_POOL_SIZE",
+ "SET_NETWORK_POLICY"
+ ],
+ "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.\nThis field is deprecated, use location instead.",
+ "type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Not set.",
+ "The operation has been created.",
+ "The operation is currently running.",
+ "The operation is done, either cancelled or completed.",
+ "The operation is aborting."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "DONE",
+ "ABORTING"
+ ],
+ "description": "The current status of the operation.",
+ "type": "string"
+ },
+ "statusMessage": {
+ "description": "If an error has occurred, a textual description of the error.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The server-assigned ID for the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "AddonsConfig": {
+ "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.",
+ "type": "object",
+ "properties": {
+ "horizontalPodAutoscaling": {
+ "$ref": "HorizontalPodAutoscaling",
+ "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods."
+ },
+ "httpLoadBalancing": {
+ "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster.",
+ "$ref": "HttpLoadBalancing"
+ },
+ "kubernetesDashboard": {
+ "description": "Configuration for the Kubernetes Dashboard.",
+ "$ref": "KubernetesDashboard"
+ }
+ },
+ "id": "AddonsConfig"
+ },
+ "RollbackNodePoolUpgradeRequest": {
+ "id": "RollbackNodePoolUpgradeRequest",
+ "description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.",
+ "type": "object",
+ "properties": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ }
+ },
+ "UpdateClusterRequest": {
+ "description": "UpdateClusterRequest updates the settings of a cluster.",
+ "type": "object",
+ "properties": {
+ "update": {
+ "$ref": "ClusterUpdate",
+ "description": "A description of the update."
+ },
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateClusterRequest"
+ },
+ "NetworkPolicy": {
+ "description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether network policy is enabled on the cluster."
+ },
+ "provider": {
+ "enumDescriptions": [
+ "Not set",
+ "Tigera (Calico Felix)."
+ ],
+ "enum": [
+ "PROVIDER_UNSPECIFIED",
+ "CALICO"
+ ],
+ "description": "The selected network policy provider.",
+ "type": "string"
+ }
+ },
+ "id": "NetworkPolicy"
+ },
+ "Cluster": {
+ "description": "A Google Container Engine cluster.",
+ "type": "object",
+ "properties": {
+ "currentMasterVersion": {
+ "description": "[Output only] The current software version of the master endpoint.",
+ "type": "string"
+ },
+ "nodeConfig": {
+ "$ref": "NodeConfig",
+ "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used."
+ },
+ "addonsConfig": {
+ "description": "Configurations for the various addons available to run in the cluster.",
+ "$ref": "AddonsConfig"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Not set.",
+ "The PROVISIONING state indicates the cluster is being created.",
+ "The RUNNING state indicates the cluster has been created and is fully\nusable.",
+ "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.",
+ "The STOPPING state indicates the cluster is being deleted.",
+ "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "RUNNING",
+ "RECONCILING",
+ "STOPPING",
+ "ERROR"
+ ],
+ "description": "[Output only] The current status of this cluster.",
+ "type": "string"
+ },
+ "subnetwork": {
+ "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.",
+ "type": "string"
+ },
+ "currentNodeVersion": {
+ "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
+ "type": "string"
+ },
+ "initialClusterVersion": {
+ "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
+ "type": "string"
+ },
+ "ipAllocationPolicy": {
+ "$ref": "IPAllocationPolicy",
+ "description": "Configuration for cluster IP allocation."
+ },
+ "endpoint": {
+ "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
+ "type": "string"
+ },
+ "location": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "clusterIpv4Cidr": {
+ "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.",
+ "type": "string"
+ },
+ "initialNodeCount": {
+ "format": "int32",
+ "description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.",
+ "type": "integer"
+ },
+ "selfLink": {
+ "description": "[Output only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "nodePools": {
+ "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.",
+ "items": {
+ "$ref": "NodePool"
+ },
+ "type": "array"
+ },
+ "instanceGroupUrls": {
+ "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\ncluster.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "networkPolicy": {
+ "description": "Configuration options for the NetworkPolicy feature.",
+ "$ref": "NetworkPolicy"
+ },
+ "servicesIpv4Cidr": {
+ "description": "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.",
+ "type": "string"
+ },
+ "enableKubernetesAlpha": {
+ "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1beta1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.",
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string",
+ "description": "An optional description of this cluster."
+ },
+ "currentNodeCount": {
+ "format": "int32",
+ "description": "[Output only] The number of nodes currently in the cluster.",
+ "type": "integer"
+ },
+ "monitoringService": {
+ "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* `monitoring.googleapis.com` - the Google Cloud Monitoring service.\n* `none` - no metrics will be exported from the cluster.\n* if left as an empty string, `monitoring.googleapis.com` will be used.",
+ "type": "string"
+ },
+ "network": {
+ "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use location instead.",
+ "type": "string"
+ },
+ "expireTime": {
+ "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "nodeIpv4CidrSize": {
+ "format": "int32",
+ "description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange.",
+ "type": "integer"
+ },
+ "loggingService": {
+ "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
+ "type": "string"
+ },
+ "masterAuthorizedNetworksConfig": {
+ "description": "The configuration options for master authorized networks feature.",
+ "$ref": "MasterAuthorizedNetworksConfig"
+ },
+ "statusMessage": {
+ "description": "[Output only] Additional information about the current status of this\ncluster, if available.",
+ "type": "string"
+ },
+ "masterAuth": {
+ "description": "The authentication information for accessing the master endpoint.",
+ "$ref": "MasterAuth"
+ }
+ },
+ "id": "Cluster"
+ },
+ "CreateNodePoolRequest": {
+ "description": "CreateNodePoolRequest creates a node pool for a cluster.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead."
+ },
+ "parent": {
+ "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ },
+ "nodePool": {
+ "$ref": "NodePool",
+ "description": "The node pool to create."
+ },
+ "clusterId": {
+ "type": "string",
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead."
+ }
+ },
+ "id": "CreateNodePoolRequest"
+ },
+ "ListOperationsResponse": {
+ "description": "ListOperationsResponse is the result of ListOperationsRequest.",
+ "type": "object",
+ "properties": {
+ "operations": {
+ "description": "A list of operations in the project in the specified zone.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ },
+ "missingZones": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones."
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "CidrBlock": {
+ "description": "CidrBlock contains an optional name and one CIDR block.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "type": "string",
+ "description": "display_name is an optional field for users to identify CIDR blocks."
+ },
+ "cidrBlock": {
+ "description": "cidr_block must be specified in CIDR notation.",
+ "type": "string"
+ }
+ },
+ "id": "CidrBlock"
+ },
+ "ServerConfig": {
+ "description": "Container Engine service configuration.",
+ "type": "object",
+ "properties": {
+ "validMasterVersions": {
+ "description": "List of valid master versions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "defaultImageType": {
+ "description": "Default image type.",
+ "type": "string"
+ },
+ "defaultClusterVersion": {
+ "type": "string",
+ "description": "Version of Kubernetes the service deploys by default."
+ },
+ "validImageTypes": {
+ "description": "List of valid image types.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "validNodeVersions": {
+ "description": "List of valid node upgrade target versions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ServerConfig"
+ },
+ "NodeConfig": {
+ "description": "Parameters that describe the nodes in a cluster.",
+ "type": "object",
+ "properties": {
+ "preemptible": {
+ "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninforamtion about preemptible VM instances.",
+ "type": "boolean"
+ },
+ "labels": {
+ "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": {
+ "format": "int32",
+ "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.",
+ "type": "integer"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
+ "type": "object"
+ },
+ "diskSizeGb": {
+ "format": "int32",
+ "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.",
+ "type": "integer"
+ },
+ "tags": {
+ "description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "serviceAccount": {
+ "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.",
+ "type": "string"
+ },
+ "accelerators": {
+ "description": "A list of hardware accelerators to be attached to each node.\nSee https://cloud.google.com/compute/docs/gpus for more information about\nsupport for GPUs.",
+ "items": {
+ "$ref": "AcceleratorConfig"
+ },
+ "type": "array"
+ },
+ "machineType": {
+ "description": "The name of a Google Compute Engine [machine\ntype](/compute/docs/machine-types) (e.g.\n`n1-standard-1`).\n\nIf unspecified, the default machine type is\n`n1-standard-1`.",
+ "type": "string"
+ },
+ "imageType": {
+ "description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
+ "type": "string"
+ },
+ "oauthScopes": {
+ "description": "The set of Google API scopes to be made available on all of the\nnode VMs under the \"default\" service account.\n\nThe following scopes are recommended, but not required, and by default are\nnot included:\n\n* `https://www.googleapis.com/auth/compute` is required for mounting\npersistent storage on your nodes.\n* `https://www.googleapis.com/auth/devstorage.read_only` is required for\ncommunicating with **gcr.io**\n(the [Google Container Registry](/container-registry/)).\n\nIf unspecified, no scopes are added, unless Cloud Logging or Cloud\nMonitoring are enabled, in which case their required scopes will be added.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "NodeConfig"
+ },
+ "MasterAuth": {
+ "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
+ "type": "object",
+ "properties": {
+ "clusterCaCertificate": {
+ "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
+ "type": "string"
+ },
+ "clientCertificate": {
+ "type": "string",
+ "description": "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint."
+ },
+ "username": {
+ "description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
+ "type": "string"
+ },
+ "password": {
+ "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
+ "type": "string"
+ },
+ "clientCertificateConfig": {
+ "$ref": "ClientCertificateConfig",
+ "description": "Configuration for client certificate authentication on the cluster. If no\nconfiguration is specified, a client certificate is issued."
+ },
+ "clientKey": {
+ "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
+ "type": "string"
+ }
+ },
+ "id": "MasterAuth"
+ },
+ "AutoUpgradeOptions": {
+ "properties": {
+ "description": {
+ "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
+ "type": "string"
+ },
+ "autoUpgradeStartTime": {
+ "type": "string",
+ "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."
+ }
+ },
+ "id": "AutoUpgradeOptions",
+ "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
+ "type": "object"
+ },
+ "ListClustersResponse": {
+ "description": "ListClustersResponse is the result of ListClustersRequest.",
+ "type": "object",
+ "properties": {
+ "clusters": {
+ "description": "A list of clusters in the project in the specified zone, or\nacross all ones.",
+ "items": {
+ "$ref": "Cluster"
+ },
+ "type": "array"
+ },
+ "missingZones": {
+ "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListClustersResponse"
+ },
+ "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"
+ },
+ "ClientCertificateConfig": {
+ "description": "Configuration for client certificates on the cluster.",
+ "type": "object",
+ "properties": {
+ "issueClientCertificate": {
+ "description": "Issue a client certificate.",
+ "type": "boolean"
+ }
+ },
+ "id": "ClientCertificateConfig"
+ },
+ "SetNetworkPolicyRequest": {
+ "id": "SetNetworkPolicyRequest",
+ "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
+ "type": "object",
+ "properties": {
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "networkPolicy": {
+ "description": "Configuration options for the NetworkPolicy feature.",
+ "$ref": "NetworkPolicy"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "type": "string",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead."
+ }
+ }
+ },
+ "NodePoolAutoscaling": {
+ "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
+ "type": "object",
+ "properties": {
+ "maxNodeCount": {
+ "format": "int32",
+ "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
+ "type": "integer"
+ },
+ "minNodeCount": {
+ "format": "int32",
+ "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
+ "type": "integer"
+ },
+ "enabled": {
+ "description": "Is autoscaling enabled for this node pool.",
+ "type": "boolean"
+ }
+ },
+ "id": "NodePoolAutoscaling"
+ },
+ "SetMasterAuthRequest": {
+ "type": "object",
+ "properties": {
+ "update": {
+ "description": "A description of the update.",
+ "$ref": "MasterAuth"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "action": {
+ "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"
+ ],
+ "description": "The exact form of action to be taken on the master auth"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "SetMasterAuthRequest",
+ "description": "SetMasterAuthRequest updates the admin password of a cluster."
+ },
+ "IPAllocationPolicy": {
+ "description": "Configuration for controlling how IPs are allocated in the cluster.",
+ "type": "object",
+ "properties": {
+ "servicesIpv4Cidr": {
+ "description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range will be chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range be chosen with a specific\nnetmask.\n\nSet to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
+ "type": "string"
+ },
+ "createSubnetwork": {
+ "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.",
+ "type": "boolean"
+ },
+ "useIpAliases": {
+ "description": "Whether alias IPs will be used for pod IPs in the cluster.",
+ "type": "boolean"
+ },
+ "subnetworkName": {
+ "description": "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork.",
+ "type": "string"
+ },
+ "clusterIpv4Cidr": {
+ "description": "The IP address range for the cluster pod IPs. If this field is set, then\n`cluster.cluster_ipv4_cidr` must be left blank.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range will be chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range be chosen with a specific\nnetmask.\n\nSet to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
+ "type": "string"
+ },
+ "nodeIpv4Cidr": {
+ "type": "string",
+ "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range will be chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range be chosen with a specific\nnetmask.\n\nSet to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use."
+ }
+ },
+ "id": "IPAllocationPolicy"
+ },
+ "ClusterUpdate": {
+ "id": "ClusterUpdate",
+ "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.",
+ "type": "object",
+ "properties": {
+ "desiredMasterAuthorizedNetworksConfig": {
+ "$ref": "MasterAuthorizedNetworksConfig",
+ "description": "The desired configuration options for master authorized networks feature."
+ },
+ "desiredLocations": {
+ "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "desiredNodePoolAutoscaling": {
+ "$ref": "NodePoolAutoscaling",
+ "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool."
+ },
+ "desiredMonitoringService": {
+ "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
+ "type": "string"
+ },
+ "desiredImageType": {
+ "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
+ "type": "string"
+ },
+ "desiredAddonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
+ },
+ "desiredNodePoolId": {
+ "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
+ "type": "string"
+ },
+ "desiredNodeVersion": {
+ "type": "string",
+ "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server."
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "id": "SetNodePoolManagementRequest",
+ "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
+ "type": "object",
+ "properties": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ },
+ "management": {
+ "description": "NodeManagement configuration for the node pool.",
+ "$ref": "NodeManagement"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {}
+ },
+ "MasterAuthorizedNetworksConfig": {
+ "description": "Configuration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.",
+ "type": "object",
+ "properties": {
+ "cidrBlocks": {
+ "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
+ "items": {
+ "$ref": "CidrBlock"
+ },
+ "type": "array"
+ },
+ "enabled": {
+ "description": "Whether or not master authorized networks is enabled.",
+ "type": "boolean"
+ }
+ },
+ "id": "MasterAuthorizedNetworksConfig"
+ },
+ "CreateClusterRequest": {
+ "id": "CreateClusterRequest",
+ "description": "CreateClusterRequest creates a cluster.",
+ "type": "object",
+ "properties": {
+ "cluster": {
+ "description": "A [cluster\nresource](/container-engine/reference/rest/v1beta1/projects.zones.clusters)",
+ "$ref": "Cluster"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string"
+ }
+ }
+ },
+ "ListNodePoolsResponse": {
+ "id": "ListNodePoolsResponse",
+ "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
+ "type": "object",
+ "properties": {
+ "nodePools": {
+ "description": "A list of node pools for a cluster.",
+ "items": {
+ "$ref": "NodePool"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "CompleteIPRotationRequest": {
+ "properties": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "CompleteIPRotationRequest",
+ "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
+ "type": "object"
+ },
+ "StartIPRotationRequest": {
+ "properties": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ }
+ },
+ "id": "StartIPRotationRequest",
+ "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"
+ }
+ },
+ "protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "canonicalName": "Container",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://container.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "container",
+ "batchPath": "batch",
+ "title": "Google Container Engine API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "zones": {
+ "methods": {
+ "getServerconfig": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "type": "string",
+ "location": "query",
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'."
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig",
+ "description": "Returns configuration info about the Container Engine service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ]
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "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.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "id": "container.projects.zones.operations.cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Cancels the specified operation."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "parameters": {
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string"
+ },
+ "operationId": {
+ "location": "path",
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "id": "container.projects.zones.operations.get",
+ "description": "Gets the specified operation."
+ },
+ "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).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ },
+ "parent": {
+ "location": "query",
+ "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations",
+ "id": "container.projects.zones.operations.list",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations",
+ "description": "Lists all operations in a project in a specific zone or all zones."
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
+ "completeIpRotation": {
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "id": "container.projects.zones.clusters.completeIpRotation",
+ "description": "Completes master IP rotation.",
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "parameters": {
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.get",
+ "description": "Gets the details of a specific cluster."
+ },
+ "legacyAbac": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "id": "container.projects.zones.clusters.legacyAbac",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ }
+ },
+ "setNetworkPolicy": {
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "id": "container.projects.zones.clusters.setNetworkPolicy",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy"
+ },
+ "update": {
+ "description": "Updates the settings of a specific cluster.",
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.update"
+ },
+ "startIpRotation": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "id": "container.projects.zones.clusters.startIpRotation",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "description": "Start master IP rotation.",
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ }
+ },
+ "setMasterAuth": {
+ "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
+ "request": {
+ "$ref": "SetMasterAuthRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
+ "id": "container.projects.zones.clusters.setMasterAuth"
+ },
+ "delete": {
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.delete",
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
+ },
+ "list": {
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ },
+ "parent": {
+ "location": "query",
+ "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.list",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "GET"
+ },
+ "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",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.create",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters"
+ },
+ "resourceLabels": {
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "id": "container.projects.zones.clusters.resourceLabels",
+ "description": "Sets labels on a cluster.",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "list": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.list",
+ "description": "Lists the node pools for a cluster.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameters": {
+ "parent": {
+ "location": "query",
+ "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead."
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "rollback": {
+ "request": {
+ "$ref": "RollbackNodePoolUpgradeRequest"
+ },
+ "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "nodePoolId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ "id": "container.projects.zones.clusters.nodePools.rollback",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback"
+ },
+ "create": {
+ "description": "Creates a node pool for a cluster.",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.create"
+ },
+ "get": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.get",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "description": "Retrieves the node pool requested.",
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "nodePoolId": {
+ "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "setManagement": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "nodePoolId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the node pool to update.\nThis field is deprecated, use name instead."
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "id": "container.projects.zones.clusters.nodePools.setManagement",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "description": "Sets the NodeManagement options for a node pool.",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ }
+ },
+ "delete": {
+ "description": "Deletes a node pool from a cluster.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.delete"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "getServerConfig": {
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
+ "id": "container.projects.locations.getServerConfig",
+ "path": "v1beta1/{+name}/serverConfig",
+ "description": "Returns configuration info about the Container Engine service."
+ }
+ },
+ "resources": {
+ "clusters": {
+ "methods": {
+ "completeIpRotation": {
+ "description": "Completes master IP rotation.",
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation",
+ "path": "v1beta1/{+name}:completeIpRotation",
+ "id": "container.projects.locations.clusters.completeIpRotation"
+ },
+ "setNetworkPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy",
+ "path": "v1beta1/{+name}:setNetworkPolicy",
+ "id": "container.projects.locations.clusters.setNetworkPolicy",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "description": "Enables/Disables Network Policy for a cluster."
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.get",
+ "description": "Gets the details of a specific cluster.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "name"
+ ]
+ },
+ "update": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "id": "container.projects.locations.clusters.update",
+ "path": "v1beta1/{+name}",
+ "description": "Updates the settings of a specific cluster.",
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ }
+ },
+ "startIpRotation": {
+ "path": "v1beta1/{+name}:startIpRotation",
+ "id": "container.projects.locations.clusters.startIpRotation",
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ },
+ "description": "Start master IP rotation.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation"
+ },
+ "setMasterAuth": {
+ "id": "container.projects.locations.clusters.setMasterAuth",
+ "path": "v1beta1/{+name}:setMasterAuth",
+ "request": {
+ "$ref": "SetMasterAuthRequest"
+ },
+ "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth"
+ },
+ "delete": {
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.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.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "zone": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead."
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "id": "container.projects.locations.clusters.list",
+ "path": "v1beta1/{+parent}/clusters",
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones."
+ },
+ "create": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "id": "container.projects.locations.clusters.create",
+ "path": "v1beta1/{+parent}/clusters",
+ "request": {
+ "$ref": "CreateClusterRequest"
+ },
+ "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "setLegacyAbac": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac",
+ "path": "v1beta1/{+name}:setLegacyAbac",
+ "id": "container.projects.locations.clusters.setLegacyAbac",
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ }
+ },
+ "setResourceLabels": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels",
+ "path": "v1beta1/{+name}:setResourceLabels",
+ "id": "container.projects.locations.clusters.setResourceLabels",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ },
+ "description": "Sets labels on a cluster."
+ }
+ },
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "setManagement": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement",
+ "id": "container.projects.locations.clusters.nodePools.setManagement",
+ "path": "v1beta1/{+name}:setManagement",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ },
+ "description": "Sets the NodeManagement options for a node pool.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'."
+ }
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "nodePoolId": {
+ "location": "query",
+ "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
+ "id": "container.projects.locations.clusters.nodePools.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes a node pool from a cluster."
+ },
+ "list": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ "id": "container.projects.locations.clusters.nodePools.list",
+ "path": "v1beta1/{+parent}/nodePools",
+ "description": "Lists the node pools for a cluster.",
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead."
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "location": "query",
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "rollback": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
+ "path": "v1beta1/{+name}:rollback",
+ "id": "container.projects.locations.clusters.nodePools.rollback",
+ "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ "request": {
+ "$ref": "RollbackNodePoolUpgradeRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ "path": "v1beta1/{+parent}/nodePools",
+ "id": "container.projects.locations.clusters.nodePools.create",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ },
+ "description": "Creates a node pool for a cluster."
+ },
+ "get": {
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "clusterId": {
+ "location": "query",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
+ "id": "container.projects.locations.clusters.nodePools.get",
+ "path": "v1beta1/{+name}",
+ "description": "Retrieves the node pool requested."
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+ "path": "v1beta1/{+name}:cancel",
+ "id": "container.projects.locations.operations.cancel",
+ "description": "Cancels the specified operation.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ }
+ },
+ "get": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+ "id": "container.projects.locations.operations.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets the specified operation.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string",
+ "required": true
+ },
+ "operationId": {
+ "location": "query",
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ }
+ },
+ "list": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
+ "id": "container.projects.locations.operations.list",
+ "path": "v1beta1/{+parent}/operations",
+ "description": "Lists all operations in a project in a specific zone or all zones.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://container.googleapis.com/",
+ "servicePath": "",
+ "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",
+ "basePath": "",
+ "id": "container:v1beta1",
+ "documentationLink": "https://cloud.google.com/container-engine/",
+ "revision": "20170814",
+ "discoveryVersion": "v1"
}
diff --git a/container/v1beta1/container-gen.go b/container/v1beta1/container-gen.go
index 80784ed..6527413 100644
--- a/container/v1beta1/container-gen.go
+++ b/container/v1beta1/container-gen.go
@@ -1,4 +1,6 @@
-// Package container provides access to the .
+// Package container provides access to the Google Container Engine API.
+//
+// See https://cloud.google.com/container-engine/
//
// Usage example:
//
@@ -38,16 +40,23 @@
var _ = context.Canceled
var _ = ctxhttp.Do
-const apiId = ""
-const apiName = ""
-const apiVersion = ""
-const basePath = "https://www.googleapis.com/discovery/v1/apis"
+const apiId = "container:v1beta1"
+const apiName = "container"
+const apiVersion = "v1beta1"
+const basePath = "https://container.googleapis.com/"
+
+// OAuth2 scopes used by this API.
+const (
+ // View and manage your data across Google Cloud Platform services
+ CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
+)
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
+ s.Projects = NewProjectsService(s)
return s, nil
}
@@ -55,6 +64,8 @@
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
+
+ Projects *ProjectsService
}
func (s *Service) userAgent() string {
@@ -63,3 +74,8948 @@
}
return googleapi.UserAgent + " " + s.UserAgent
}
+
+func NewProjectsService(s *Service) *ProjectsService {
+ rs := &ProjectsService{s: s}
+ rs.Locations = NewProjectsLocationsService(s)
+ rs.Zones = NewProjectsZonesService(s)
+ return rs
+}
+
+type ProjectsService struct {
+ s *Service
+
+ Locations *ProjectsLocationsService
+
+ Zones *ProjectsZonesService
+}
+
+func NewProjectsLocationsService(s *Service) *ProjectsLocationsService {
+ rs := &ProjectsLocationsService{s: s}
+ rs.Clusters = NewProjectsLocationsClustersService(s)
+ rs.Operations = NewProjectsLocationsOperationsService(s)
+ return rs
+}
+
+type ProjectsLocationsService struct {
+ s *Service
+
+ Clusters *ProjectsLocationsClustersService
+
+ Operations *ProjectsLocationsOperationsService
+}
+
+func NewProjectsLocationsClustersService(s *Service) *ProjectsLocationsClustersService {
+ rs := &ProjectsLocationsClustersService{s: s}
+ rs.NodePools = NewProjectsLocationsClustersNodePoolsService(s)
+ return rs
+}
+
+type ProjectsLocationsClustersService struct {
+ s *Service
+
+ NodePools *ProjectsLocationsClustersNodePoolsService
+}
+
+func NewProjectsLocationsClustersNodePoolsService(s *Service) *ProjectsLocationsClustersNodePoolsService {
+ rs := &ProjectsLocationsClustersNodePoolsService{s: s}
+ return rs
+}
+
+type ProjectsLocationsClustersNodePoolsService struct {
+ s *Service
+}
+
+func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService {
+ rs := &ProjectsLocationsOperationsService{s: s}
+ return rs
+}
+
+type ProjectsLocationsOperationsService struct {
+ s *Service
+}
+
+func NewProjectsZonesService(s *Service) *ProjectsZonesService {
+ rs := &ProjectsZonesService{s: s}
+ rs.Clusters = NewProjectsZonesClustersService(s)
+ rs.Operations = NewProjectsZonesOperationsService(s)
+ return rs
+}
+
+type ProjectsZonesService struct {
+ s *Service
+
+ Clusters *ProjectsZonesClustersService
+
+ Operations *ProjectsZonesOperationsService
+}
+
+func NewProjectsZonesClustersService(s *Service) *ProjectsZonesClustersService {
+ rs := &ProjectsZonesClustersService{s: s}
+ rs.NodePools = NewProjectsZonesClustersNodePoolsService(s)
+ return rs
+}
+
+type ProjectsZonesClustersService struct {
+ s *Service
+
+ NodePools *ProjectsZonesClustersNodePoolsService
+}
+
+func NewProjectsZonesClustersNodePoolsService(s *Service) *ProjectsZonesClustersNodePoolsService {
+ rs := &ProjectsZonesClustersNodePoolsService{s: s}
+ return rs
+}
+
+type ProjectsZonesClustersNodePoolsService struct {
+ s *Service
+}
+
+func NewProjectsZonesOperationsService(s *Service) *ProjectsZonesOperationsService {
+ rs := &ProjectsZonesOperationsService{s: s}
+ return rs
+}
+
+type ProjectsZonesOperationsService struct {
+ s *Service
+}
+
+// AcceleratorConfig: AcceleratorConfig represents a Hardware
+// Accelerator request.
+type AcceleratorConfig struct {
+ // AcceleratorCount: The number of the accelerator cards exposed to an
+ // instance.
+ AcceleratorCount int64 `json:"acceleratorCount,omitempty,string"`
+
+ // AcceleratorType: The accelerator type resource name. List of
+ // supported accelerators
+ // [here](/compute/docs/gpus/#Introduction)
+ AcceleratorType string `json:"acceleratorType,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AcceleratorCount") 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. "AcceleratorCount") 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 *AcceleratorConfig) MarshalJSON() ([]byte, error) {
+ type noMethod AcceleratorConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AddonsConfig: Configuration for the addons that can be automatically
+// spun up in the
+// cluster, enabling additional functionality.
+type AddonsConfig struct {
+ // HorizontalPodAutoscaling: Configuration for the horizontal pod
+ // autoscaling feature, which
+ // increases or decreases the number of replica pods a replication
+ // controller
+ // has based on the resource usage of the existing pods.
+ HorizontalPodAutoscaling *HorizontalPodAutoscaling `json:"horizontalPodAutoscaling,omitempty"`
+
+ // HttpLoadBalancing: Configuration for the HTTP (L7) load balancing
+ // controller addon, which
+ // makes it easy to set up HTTP load balancers for services in a
+ // cluster.
+ HttpLoadBalancing *HttpLoadBalancing `json:"httpLoadBalancing,omitempty"`
+
+ // KubernetesDashboard: Configuration for the Kubernetes Dashboard.
+ KubernetesDashboard *KubernetesDashboard `json:"kubernetesDashboard,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "HorizontalPodAutoscaling") 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. "HorizontalPodAutoscaling")
+ // 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 *AddonsConfig) MarshalJSON() ([]byte, error) {
+ type noMethod AddonsConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AutoUpgradeOptions: AutoUpgradeOptions defines the set of options for
+// the user to control how
+// the Auto Upgrades will proceed.
+type AutoUpgradeOptions struct {
+ // AutoUpgradeStartTime: [Output only] This field is set when upgrades
+ // are about to commence
+ // with the approximate start time for the upgrades,
+ // in
+ // [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ AutoUpgradeStartTime string `json:"autoUpgradeStartTime,omitempty"`
+
+ // Description: [Output only] This field is set when upgrades are about
+ // to commence
+ // with the description of the upgrade.
+ Description string `json:"description,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "AutoUpgradeStartTime") 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. "AutoUpgradeStartTime") 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 *AutoUpgradeOptions) MarshalJSON() ([]byte, error) {
+ type noMethod AutoUpgradeOptions
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CancelOperationRequest: CancelOperationRequest cancels a single
+// operation.
+type CancelOperationRequest struct {
+ // Name: The name (project, location, operation id) of the operation to
+ // cancel.
+ // Specified in the format 'projects/*/locations/*/operations/*'.
+ Name string `json:"name,omitempty"`
+
+ // OperationId: The server-assigned `name` of the operation.
+ // This field is deprecated, use name instead.
+ OperationId string `json:"operationId,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://support.google.com/cloud/answer/6158840).
+ // This
+ // field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the operation
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Name") 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. "Name") 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 *CancelOperationRequest) MarshalJSON() ([]byte, error) {
+ type noMethod CancelOperationRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CidrBlock: CidrBlock contains an optional name and one CIDR block.
+type CidrBlock struct {
+ // CidrBlock: cidr_block must be specified in CIDR notation.
+ CidrBlock string `json:"cidrBlock,omitempty"`
+
+ // DisplayName: display_name is an optional field for users to identify
+ // CIDR blocks.
+ DisplayName string `json:"displayName,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CidrBlock") 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. "CidrBlock") 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 *CidrBlock) MarshalJSON() ([]byte, error) {
+ type noMethod CidrBlock
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ClientCertificateConfig: Configuration for client certificates on the
+// cluster.
+type ClientCertificateConfig struct {
+ // IssueClientCertificate: Issue a client certificate.
+ IssueClientCertificate bool `json:"issueClientCertificate,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "IssueClientCertificate") 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. "IssueClientCertificate")
+ // 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 *ClientCertificateConfig) MarshalJSON() ([]byte, error) {
+ type noMethod ClientCertificateConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Cluster: A Google Container Engine cluster.
+type Cluster struct {
+ // AddonsConfig: Configurations for the various addons available to run
+ // in the cluster.
+ AddonsConfig *AddonsConfig `json:"addonsConfig,omitempty"`
+
+ // ClusterIpv4Cidr: The IP address range of the container pods in this
+ // cluster,
+ // in
+ // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ //
+ // notation (e.g. `10.96.0.0/14`). Leave blank to have
+ // one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
+ ClusterIpv4Cidr string `json:"clusterIpv4Cidr,omitempty"`
+
+ // CreateTime: [Output only] The time the cluster was created,
+ // in
+ // [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // CurrentMasterVersion: [Output only] The current software version of
+ // the master endpoint.
+ CurrentMasterVersion string `json:"currentMasterVersion,omitempty"`
+
+ // CurrentNodeCount: [Output only] The number of nodes currently in the
+ // cluster.
+ CurrentNodeCount int64 `json:"currentNodeCount,omitempty"`
+
+ // CurrentNodeVersion: [Output only] The current version of the node
+ // software components.
+ // If they are currently at multiple versions because they're in the
+ // process
+ // of being upgraded, this reflects the minimum version of all nodes.
+ CurrentNodeVersion string `json:"currentNodeVersion,omitempty"`
+
+ // Description: An optional description of this cluster.
+ Description string `json:"description,omitempty"`
+
+ // EnableKubernetesAlpha: Kubernetes alpha features are enabled on this
+ // cluster. This includes alpha
+ // API groups (e.g. v1beta1) and features that may not be production
+ // ready in
+ // the kubernetes version of the master and nodes.
+ // The cluster has no SLA for uptime and master/node upgrades are
+ // disabled.
+ // Alpha enabled clusters are automatically deleted thirty days
+ // after
+ // creation.
+ EnableKubernetesAlpha bool `json:"enableKubernetesAlpha,omitempty"`
+
+ // Endpoint: [Output only] The IP address of this cluster's master
+ // endpoint.
+ // The endpoint can be accessed from the internet
+ // at
+ // `https://username:password@endpoint/`.
+ //
+ // See the `masterAuth` property of this resource for username
+ // and
+ // password information.
+ Endpoint string `json:"endpoint,omitempty"`
+
+ // ExpireTime: [Output only] The time the cluster will be
+ // automatically
+ // deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text
+ // format.
+ ExpireTime string `json:"expireTime,omitempty"`
+
+ // InitialClusterVersion: The initial Kubernetes version for this
+ // cluster. Valid versions are those
+ // found in validMasterVersions returned by getServerConfig. The
+ // version can
+ // be upgraded over time; such upgrades are reflected
+ // in
+ // currentMasterVersion and currentNodeVersion.
+ InitialClusterVersion string `json:"initialClusterVersion,omitempty"`
+
+ // InitialNodeCount: The number of nodes to create in this cluster. You
+ // must ensure that your
+ // Compute Engine <a href="/compute/docs/resource-quotas">resource
+ // quota</a>
+ // is sufficient for this number of instances. You must also have
+ // available
+ // firewall and routes quota.
+ // For requests, this field should only be used in lieu of a
+ // "node_pool" object, since this configuration (along with
+ // the
+ // "node_config") will be used to create a "NodePool" object with
+ // an
+ // auto-generated name. Do not use this and a node_pool at the same
+ // time.
+ InitialNodeCount int64 `json:"initialNodeCount,omitempty"`
+
+ // InstanceGroupUrls: [Output only] The resource URLs of
+ // [instance
+ // groups](/compute/docs/instance-groups/) associated with this
+ // cluster.
+ InstanceGroupUrls []string `json:"instanceGroupUrls,omitempty"`
+
+ // IpAllocationPolicy: Configuration for cluster IP allocation.
+ IpAllocationPolicy *IPAllocationPolicy `json:"ipAllocationPolicy,omitempty"`
+
+ // Location: [Output only] The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/regions-zones/regions-zones#available)
+ // or
+ // [region](/compute/docs/regions-zones/regions-zones#available) in
+ // which
+ // the cluster resides.
+ Location string `json:"location,omitempty"`
+
+ // Locations: The list of Google Compute
+ // Engine
+ // [locations](/compute/docs/zones#available) in which the cluster's
+ // nodes
+ // should be located.
+ Locations []string `json:"locations,omitempty"`
+
+ // LoggingService: The logging service the cluster should use to write
+ // logs.
+ // Currently available options:
+ //
+ // * `logging.googleapis.com` - the Google Cloud Logging service.
+ // * `none` - no logs will be exported from the cluster.
+ // * if left as an empty string,`logging.googleapis.com` will be used.
+ LoggingService string `json:"loggingService,omitempty"`
+
+ // MasterAuth: The authentication information for accessing the master
+ // endpoint.
+ MasterAuth *MasterAuth `json:"masterAuth,omitempty"`
+
+ // MasterAuthorizedNetworksConfig: The configuration options for master
+ // authorized networks feature.
+ MasterAuthorizedNetworksConfig *MasterAuthorizedNetworksConfig `json:"masterAuthorizedNetworksConfig,omitempty"`
+
+ // MonitoringService: The monitoring service the cluster should use to
+ // write metrics.
+ // Currently available options:
+ //
+ // * `monitoring.googleapis.com` - the Google Cloud Monitoring
+ // service.
+ // * `none` - no metrics will be exported from the cluster.
+ // * if left as an empty string, `monitoring.googleapis.com` will be
+ // used.
+ MonitoringService string `json:"monitoringService,omitempty"`
+
+ // Name: The name of this cluster. The name must be unique within this
+ // project
+ // and zone, and can be up to 40 characters with the following
+ // restrictions:
+ //
+ // * Lowercase letters, numbers, and hyphens only.
+ // * Must start with a letter.
+ // * Must end with a number or a letter.
+ Name string `json:"name,omitempty"`
+
+ // Network: The name of the Google Compute
+ // Engine
+ // [network](/compute/docs/networks-and-firewalls#networks) to which
+ // the
+ // cluster is connected. If left unspecified, the `default` network
+ // will be used.
+ Network string `json:"network,omitempty"`
+
+ // NetworkPolicy: Configuration options for the NetworkPolicy feature.
+ NetworkPolicy *NetworkPolicy `json:"networkPolicy,omitempty"`
+
+ // NodeConfig: Parameters used in creating the cluster's nodes.
+ // See `nodeConfig` for the description of its properties.
+ // For requests, this field should only be used in lieu of a
+ // "node_pool" object, since this configuration (along with
+ // the
+ // "initial_node_count") will be used to create a "NodePool" object with
+ // an
+ // auto-generated name. Do not use this and a node_pool at the same
+ // time.
+ // For responses, this field will be populated with the node
+ // configuration of
+ // the first node pool.
+ //
+ // If unspecified, the defaults are used.
+ NodeConfig *NodeConfig `json:"nodeConfig,omitempty"`
+
+ // NodeIpv4CidrSize: [Output only] The size of the address space on each
+ // node for hosting
+ // containers. This is provisioned from within the
+ // `container_ipv4_cidr`
+ // range.
+ NodeIpv4CidrSize int64 `json:"nodeIpv4CidrSize,omitempty"`
+
+ // NodePools: The node pools associated with this cluster.
+ // This field should not be set if "node_config" or "initial_node_count"
+ // are
+ // specified.
+ NodePools []*NodePool `json:"nodePools,omitempty"`
+
+ // SelfLink: [Output only] Server-defined URL for the resource.
+ SelfLink string `json:"selfLink,omitempty"`
+
+ // ServicesIpv4Cidr: [Output only] The IP address range of the
+ // Kubernetes services in
+ // this cluster,
+ // in
+ // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ //
+ // notation (e.g. `1.2.3.4/29`). Service addresses are
+ // typically put in the last `/16` from the container CIDR.
+ ServicesIpv4Cidr string `json:"servicesIpv4Cidr,omitempty"`
+
+ // Status: [Output only] The current status of this cluster.
+ //
+ // Possible values:
+ // "STATUS_UNSPECIFIED" - Not set.
+ // "PROVISIONING" - The PROVISIONING state indicates the cluster is
+ // being created.
+ // "RUNNING" - The RUNNING state indicates the cluster has been
+ // created and is fully
+ // usable.
+ // "RECONCILING" - The RECONCILING state indicates that some work is
+ // actively being done on
+ // the cluster, such as upgrading the master or node software. Details
+ // can
+ // be found in the `statusMessage` field.
+ // "STOPPING" - The STOPPING state indicates the cluster is being
+ // deleted.
+ // "ERROR" - The ERROR state indicates the cluster may be unusable.
+ // Details
+ // can be found in the `statusMessage` field.
+ Status string `json:"status,omitempty"`
+
+ // StatusMessage: [Output only] Additional information about the current
+ // status of this
+ // cluster, if available.
+ StatusMessage string `json:"statusMessage,omitempty"`
+
+ // Subnetwork: The name of the Google Compute
+ // Engine
+ // [subnetwork](/compute/docs/subnetworks) to which the
+ // cluster is connected.
+ Subnetwork string `json:"subnetwork,omitempty"`
+
+ // Zone: [Output only] The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use location instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "AddonsConfig") 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. "AddonsConfig") 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 *Cluster) MarshalJSON() ([]byte, error) {
+ type noMethod Cluster
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ClusterUpdate: ClusterUpdate describes an update to the cluster.
+// Exactly one update can
+// be applied to a cluster with each request, so at most one field can
+// be
+// provided.
+type ClusterUpdate struct {
+ // DesiredAddonsConfig: Configurations for the various addons available
+ // to run in the cluster.
+ DesiredAddonsConfig *AddonsConfig `json:"desiredAddonsConfig,omitempty"`
+
+ // DesiredImageType: The desired image type for the node pool.
+ // NOTE: Set the "desired_node_pool" field as well.
+ DesiredImageType string `json:"desiredImageType,omitempty"`
+
+ // DesiredLocations: The desired list of Google Compute
+ // Engine
+ // [locations](/compute/docs/zones#available) in which the cluster's
+ // nodes
+ // should be located. Changing the locations a cluster is in will
+ // result
+ // in nodes being either created or removed from the cluster, depending
+ // on
+ // whether locations are being added or removed.
+ //
+ // This list must always include the cluster's primary zone.
+ DesiredLocations []string `json:"desiredLocations,omitempty"`
+
+ // DesiredMasterAuthorizedNetworksConfig: The desired configuration
+ // options for master authorized networks feature.
+ DesiredMasterAuthorizedNetworksConfig *MasterAuthorizedNetworksConfig `json:"desiredMasterAuthorizedNetworksConfig,omitempty"`
+
+ // DesiredMasterVersion: The Kubernetes version to change the master to.
+ // The only valid value is the
+ // latest supported version. Use "-" to have the server automatically
+ // select
+ // the latest version.
+ DesiredMasterVersion string `json:"desiredMasterVersion,omitempty"`
+
+ // DesiredMonitoringService: The monitoring service the cluster should
+ // use to write metrics.
+ // Currently available options:
+ //
+ // * "monitoring.googleapis.com" - the Google Cloud Monitoring service
+ // * "none" - no metrics will be exported from the cluster
+ DesiredMonitoringService string `json:"desiredMonitoringService,omitempty"`
+
+ // DesiredNodePoolAutoscaling: Autoscaler configuration for the node
+ // pool specified in
+ // desired_node_pool_id. If there is only one pool in the
+ // cluster and desired_node_pool_id is not provided then
+ // the change applies to that single node pool.
+ DesiredNodePoolAutoscaling *NodePoolAutoscaling `json:"desiredNodePoolAutoscaling,omitempty"`
+
+ // DesiredNodePoolId: The node pool to be upgraded. This field is
+ // mandatory if
+ // "desired_node_version", "desired_image_family"
+ // or
+ // "desired_node_pool_autoscaling" is specified and there is more than
+ // one
+ // node pool on the cluster.
+ DesiredNodePoolId string `json:"desiredNodePoolId,omitempty"`
+
+ // DesiredNodeVersion: The Kubernetes version to change the nodes to
+ // (typically an
+ // upgrade). Use `-` to upgrade to the latest version supported by
+ // the server.
+ DesiredNodeVersion string `json:"desiredNodeVersion,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "DesiredAddonsConfig")
+ // 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. "DesiredAddonsConfig") 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 *ClusterUpdate) MarshalJSON() ([]byte, error) {
+ type noMethod ClusterUpdate
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CompleteIPRotationRequest: CompleteIPRotationRequest moves the
+// cluster master back into single-IP mode.
+type CompleteIPRotationRequest struct {
+ // ClusterId: The name of the cluster.
+ // This field is deprecated, use name instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // Name: The name (project, location, cluster id) of the cluster to
+ // complete IP rotation.
+ // Specified in the format 'projects/*/locations/*/clusters/*'.
+ Name string `json:"name,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://developers.google.com/console/help/new/#projec
+ // tnumber).
+ // This field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterId") 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. "ClusterId") 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 *CompleteIPRotationRequest) MarshalJSON() ([]byte, error) {
+ type noMethod CompleteIPRotationRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CreateClusterRequest: CreateClusterRequest creates a cluster.
+type CreateClusterRequest struct {
+ // Cluster: A
+ // [cluster
+ // resource](/container-engine/reference/rest/v1beta1/projects.z
+ // ones.clusters)
+ Cluster *Cluster `json:"cluster,omitempty"`
+
+ // Parent: The parent (project and location) where the cluster will be
+ // created.
+ // Specified in the format 'projects/*/locations/*'.
+ Parent string `json:"parent,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://support.google.com/cloud/answer/6158840).
+ // This
+ // field is deprecated, use parent instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use parent instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Cluster") 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. "Cluster") 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 *CreateClusterRequest) MarshalJSON() ([]byte, error) {
+ type noMethod CreateClusterRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CreateNodePoolRequest: CreateNodePoolRequest creates a node pool for
+// a cluster.
+type CreateNodePoolRequest struct {
+ // ClusterId: The name of the cluster.
+ // This field is deprecated, use parent instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // NodePool: The node pool to create.
+ NodePool *NodePool `json:"nodePool,omitempty"`
+
+ // Parent: The parent (project, location, cluster id) where the node
+ // pool will be created.
+ // Specified in the format
+ // 'projects/*/locations/*/clusters/*/nodePools/*'.
+ Parent string `json:"parent,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://developers.google.com/console/help/new/#projec
+ // tnumber).
+ // This field is deprecated, use parent instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use parent instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterId") 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. "ClusterId") 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 *CreateNodePoolRequest) MarshalJSON() ([]byte, error) {
+ type noMethod CreateNodePoolRequest
+ 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
+// request
+// or the response type of an API method. For instance:
+//
+// service Foo {
+// rpc Bar(google.protobuf.Empty) returns
+// (google.protobuf.Empty);
+// }
+//
+// The JSON representation for `Empty` is empty JSON object `{}`.
+type Empty struct {
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+}
+
+// HorizontalPodAutoscaling: Configuration options for the horizontal
+// pod autoscaling feature, which
+// increases or decreases the number of replica pods a replication
+// controller
+// has based on the resource usage of the existing pods.
+type HorizontalPodAutoscaling struct {
+ // Disabled: Whether the Horizontal Pod Autoscaling feature is enabled
+ // in the cluster.
+ // When enabled, it ensures that a Heapster pod is running in the
+ // cluster,
+ // which is also used by the Cloud Monitoring service.
+ Disabled bool `json:"disabled,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Disabled") 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. "Disabled") 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 *HorizontalPodAutoscaling) MarshalJSON() ([]byte, error) {
+ type noMethod HorizontalPodAutoscaling
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// HttpLoadBalancing: Configuration options for the HTTP (L7) load
+// balancing controller addon,
+// which makes it easy to set up HTTP load balancers for services in a
+// cluster.
+type HttpLoadBalancing struct {
+ // Disabled: Whether the HTTP Load Balancing controller is enabled in
+ // the cluster.
+ // When enabled, it runs a small pod in the cluster that manages the
+ // load
+ // balancers.
+ Disabled bool `json:"disabled,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Disabled") 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. "Disabled") 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 *HttpLoadBalancing) MarshalJSON() ([]byte, error) {
+ type noMethod HttpLoadBalancing
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// IPAllocationPolicy: Configuration for controlling how IPs are
+// allocated in the cluster.
+type IPAllocationPolicy struct {
+ // ClusterIpv4Cidr: The IP address range for the cluster pod IPs. If
+ // this field is set, then
+ // `cluster.cluster_ipv4_cidr` must be left blank.
+ //
+ // This field is only applicable when `use_ip_aliases` is true.
+ //
+ // Set to blank to have a range will be chosen with the default
+ // size.
+ //
+ // Set to /netmask (e.g. `/14`) to have a range be chosen with a
+ // specific
+ // netmask.
+ //
+ // Set to a
+ // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ // no
+ // tation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks
+ // (e.g.
+ // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific
+ // range
+ // to use.
+ ClusterIpv4Cidr string `json:"clusterIpv4Cidr,omitempty"`
+
+ // CreateSubnetwork: Whether a new subnetwork will be created
+ // automatically for the cluster.
+ //
+ // This field is only applicable when `use_ip_aliases` is true.
+ CreateSubnetwork bool `json:"createSubnetwork,omitempty"`
+
+ // NodeIpv4Cidr: The IP address range of the instance IPs in this
+ // cluster.
+ //
+ // This is applicable only if `create_subnetwork` is true.
+ //
+ // Set to blank to have a range will be chosen with the default
+ // size.
+ //
+ // Set to /netmask (e.g. `/14`) to have a range be chosen with a
+ // specific
+ // netmask.
+ //
+ // Set to a
+ // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ // no
+ // tation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks
+ // (e.g.
+ // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific
+ // range
+ // to use.
+ NodeIpv4Cidr string `json:"nodeIpv4Cidr,omitempty"`
+
+ // ServicesIpv4Cidr: The IP address range of the services IPs in this
+ // cluster. If blank, a range
+ // will be automatically chosen with the default size.
+ //
+ // This field is only applicable when `use_ip_aliases` is true.
+ //
+ // Set to blank to have a range will be chosen with the default
+ // size.
+ //
+ // Set to /netmask (e.g. `/14`) to have a range be chosen with a
+ // specific
+ // netmask.
+ //
+ // Set to a
+ // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ // no
+ // tation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks
+ // (e.g.
+ // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific
+ // range
+ // to use.
+ ServicesIpv4Cidr string `json:"servicesIpv4Cidr,omitempty"`
+
+ // SubnetworkName: A custom subnetwork name to be used if
+ // `create_subnetwork` is true. If
+ // this field is empty, then an automatic name will be chosen for the
+ // new
+ // subnetwork.
+ SubnetworkName string `json:"subnetworkName,omitempty"`
+
+ // UseIpAliases: Whether alias IPs will be used for pod IPs in the
+ // cluster.
+ UseIpAliases bool `json:"useIpAliases,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterIpv4Cidr") 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. "ClusterIpv4Cidr") 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 *IPAllocationPolicy) MarshalJSON() ([]byte, error) {
+ type noMethod IPAllocationPolicy
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// KubernetesDashboard: Configuration for the Kubernetes Dashboard.
+type KubernetesDashboard struct {
+ // Disabled: Whether the Kubernetes Dashboard is enabled for this
+ // cluster.
+ Disabled bool `json:"disabled,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Disabled") 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. "Disabled") 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 *KubernetesDashboard) MarshalJSON() ([]byte, error) {
+ type noMethod KubernetesDashboard
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListClustersResponse: ListClustersResponse is the result of
+// ListClustersRequest.
+type ListClustersResponse struct {
+ // Clusters: A list of clusters in the project in the specified zone,
+ // or
+ // across all ones.
+ Clusters []*Cluster `json:"clusters,omitempty"`
+
+ // MissingZones: If any zones are listed here, the list of clusters
+ // returned
+ // may be missing those zones.
+ MissingZones []string `json:"missingZones,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Clusters") 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. "Clusters") 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 *ListClustersResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListClustersResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListNodePoolsResponse: ListNodePoolsResponse is the result of
+// ListNodePoolsRequest.
+type ListNodePoolsResponse struct {
+ // NodePools: A list of node pools for a cluster.
+ NodePools []*NodePool `json:"nodePools,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "NodePools") 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. "NodePools") 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 *ListNodePoolsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListNodePoolsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListOperationsResponse: ListOperationsResponse is the result of
+// ListOperationsRequest.
+type ListOperationsResponse struct {
+ // MissingZones: If any zones are listed here, the list of operations
+ // returned
+ // may be missing the operations from those zones.
+ MissingZones []string `json:"missingZones,omitempty"`
+
+ // Operations: A list of operations in the project in the specified
+ // zone.
+ Operations []*Operation `json:"operations,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "MissingZones") 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. "MissingZones") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListOperationsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// MasterAuth: The authentication information for accessing the master
+// endpoint.
+// Authentication can be done using HTTP basic auth or using
+// client
+// certificates.
+type MasterAuth struct {
+ // ClientCertificate: [Output only] Base64-encoded public certificate
+ // used by clients to
+ // authenticate to the cluster endpoint.
+ ClientCertificate string `json:"clientCertificate,omitempty"`
+
+ // ClientCertificateConfig: Configuration for client certificate
+ // authentication on the cluster. If no
+ // configuration is specified, a client certificate is issued.
+ ClientCertificateConfig *ClientCertificateConfig `json:"clientCertificateConfig,omitempty"`
+
+ // ClientKey: [Output only] Base64-encoded private key used by clients
+ // to authenticate
+ // to the cluster endpoint.
+ ClientKey string `json:"clientKey,omitempty"`
+
+ // ClusterCaCertificate: [Output only] Base64-encoded public certificate
+ // that is the root of
+ // trust for the cluster.
+ ClusterCaCertificate string `json:"clusterCaCertificate,omitempty"`
+
+ // Password: The password to use for HTTP basic authentication to the
+ // master endpoint.
+ // Because the master endpoint is open to the Internet, you should
+ // create a
+ // strong password. If a password is provided for cluster creation,
+ // username
+ // must be non-empty.
+ Password string `json:"password,omitempty"`
+
+ // Username: The username to use for HTTP basic authentication to the
+ // master endpoint.
+ // For clusters v1.6.0 and later, you can disable basic authentication
+ // by
+ // providing an empty username.
+ Username string `json:"username,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClientCertificate")
+ // 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. "ClientCertificate") 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 *MasterAuth) MarshalJSON() ([]byte, error) {
+ type noMethod MasterAuth
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// MasterAuthorizedNetworksConfig: Configuration options for the master
+// authorized networks feature. Enabled
+// master authorized networks will disallow all external traffic to
+// access
+// Kubernetes master through HTTPS except traffic from the given CIDR
+// blocks,
+// Google Compute Engine Public IPs and Google Prod IPs.
+type MasterAuthorizedNetworksConfig struct {
+ // CidrBlocks: cidr_blocks define up to 10 external networks that could
+ // access
+ // Kubernetes master through HTTPS.
+ CidrBlocks []*CidrBlock `json:"cidrBlocks,omitempty"`
+
+ // Enabled: Whether or not master authorized networks is enabled.
+ Enabled bool `json:"enabled,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CidrBlocks") 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. "CidrBlocks") 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 *MasterAuthorizedNetworksConfig) MarshalJSON() ([]byte, error) {
+ type noMethod MasterAuthorizedNetworksConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// NetworkPolicy: Configuration options for the NetworkPolicy
+// feature.
+// https://kubernetes.io/docs/concepts/services-networking/netwo
+// rkpolicies/
+type NetworkPolicy struct {
+ // Enabled: Whether network policy is enabled on the cluster.
+ Enabled bool `json:"enabled,omitempty"`
+
+ // Provider: The selected network policy provider.
+ //
+ // Possible values:
+ // "PROVIDER_UNSPECIFIED" - Not set
+ // "CALICO" - Tigera (Calico Felix).
+ Provider string `json:"provider,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 []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 []string `json:"-"`
+}
+
+func (s *NetworkPolicy) MarshalJSON() ([]byte, error) {
+ type noMethod NetworkPolicy
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// NodeConfig: Parameters that describe the nodes in a cluster.
+type NodeConfig struct {
+ // Accelerators: A list of hardware accelerators to be attached to each
+ // node.
+ // See https://cloud.google.com/compute/docs/gpus for more information
+ // about
+ // support for GPUs.
+ Accelerators []*AcceleratorConfig `json:"accelerators,omitempty"`
+
+ // DiskSizeGb: Size of the disk attached to each node, specified in
+ // GB.
+ // The smallest allowed disk size is 10GB.
+ //
+ // If unspecified, the default disk size is 100GB.
+ DiskSizeGb int64 `json:"diskSizeGb,omitempty"`
+
+ // ImageType: The image type to use for this node. Note that for a given
+ // image type,
+ // the latest version of it will be used.
+ ImageType string `json:"imageType,omitempty"`
+
+ // Labels: The map of Kubernetes labels (key/value pairs) to be applied
+ // to each node.
+ // These will added in addition to any default label(s) that
+ // Kubernetes may apply to the node.
+ // In case of conflict in label keys, the applied set may differ
+ // depending on
+ // the Kubernetes version -- it's best to assume the behavior is
+ // undefined
+ // and conflicts should be avoided.
+ // For more information, including usage and the valid values,
+ // see:
+ // http://kubernetes.io/v1.1/docs/user-guide/labels.html
+ Labels map[string]string `json:"labels,omitempty"`
+
+ // LocalSsdCount: The number of local SSD disks to be attached to the
+ // node.
+ //
+ // The limit for this value is dependant upon the maximum number
+ // of
+ // disks available on a machine per zone.
+ // See:
+ // https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_l
+ // imits
+ // for more information.
+ LocalSsdCount int64 `json:"localSsdCount,omitempty"`
+
+ // MachineType: The name of a Google Compute Engine
+ // [machine
+ // type](/compute/docs/machine-types) (e.g.
+ // `n1-standard-1`).
+ //
+ // If unspecified, the default machine type is
+ // `n1-standard-1`.
+ MachineType string `json:"machineType,omitempty"`
+
+ // Metadata: The metadata key/value pairs assigned to instances in the
+ // cluster.
+ //
+ // Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128
+ // bytes
+ // in length. These are reflected as part of a URL in the metadata
+ // server.
+ // Additionally, to avoid ambiguity, keys must not conflict with any
+ // other
+ // metadata keys for the project or be one of the four reserved
+ // keys:
+ // "instance-template", "kube-env", "startup-script", and
+ // "user-data"
+ //
+ // Values are free-form strings, and only have meaning as interpreted
+ // by
+ // the image running in the instance. The only restriction placed on
+ // them is
+ // that each value's size must be less than or equal to 32 KB.
+ //
+ // The total size of all keys and values must be less than 512 KB.
+ Metadata map[string]string `json:"metadata,omitempty"`
+
+ // OauthScopes: The set of Google API scopes to be made available on all
+ // of the
+ // node VMs under the "default" service account.
+ //
+ // The following scopes are recommended, but not required, and by
+ // default are
+ // not included:
+ //
+ // * `https://www.googleapis.com/auth/compute` is required for
+ // mounting
+ // persistent storage on your nodes.
+ // * `https://www.googleapis.com/auth/devstorage.read_only` is required
+ // for
+ // communicating with **gcr.io**
+ // (the [Google Container Registry](/container-registry/)).
+ //
+ // If unspecified, no scopes are added, unless Cloud Logging or
+ // Cloud
+ // Monitoring are enabled, in which case their required scopes will be
+ // added.
+ OauthScopes []string `json:"oauthScopes,omitempty"`
+
+ // Preemptible: Whether the nodes are created as preemptible VM
+ // instances.
+ // See:
+ // https://cloud.google.com/compute/docs/instances/preemptible for
+ // more
+ // inforamtion about preemptible VM instances.
+ Preemptible bool `json:"preemptible,omitempty"`
+
+ // ServiceAccount: The Google Cloud Platform Service Account to be used
+ // by the node VMs. If
+ // no Service Account is specified, the "default" service account is
+ // used.
+ ServiceAccount string `json:"serviceAccount,omitempty"`
+
+ // Tags: The list of instance tags applied to all nodes. Tags are used
+ // to identify
+ // valid sources or targets for network firewalls and are specified
+ // by
+ // the client during cluster or node pool creation. Each tag within the
+ // list
+ // must comply with RFC1035.
+ Tags []string `json:"tags,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Accelerators") 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. "Accelerators") 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 *NodeConfig) MarshalJSON() ([]byte, error) {
+ type noMethod NodeConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// NodeManagement: NodeManagement defines the set of node management
+// services turned on for the
+// node pool.
+type NodeManagement struct {
+ // AutoRepair: Whether the nodes will be automatically repaired.
+ AutoRepair bool `json:"autoRepair,omitempty"`
+
+ // AutoUpgrade: Whether the nodes will be automatically upgraded.
+ AutoUpgrade bool `json:"autoUpgrade,omitempty"`
+
+ // UpgradeOptions: Specifies the Auto Upgrade knobs for the node pool.
+ UpgradeOptions *AutoUpgradeOptions `json:"upgradeOptions,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AutoRepair") 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. "AutoRepair") 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 *NodeManagement) MarshalJSON() ([]byte, error) {
+ type noMethod NodeManagement
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// NodePool: NodePool contains the name and configuration for a
+// cluster's node pool.
+// Node pools are a set of nodes (i.e. VM's), with a common
+// configuration and
+// specification, under the control of the cluster master. They may have
+// a set
+// of Kubernetes labels applied to them, which may be used to reference
+// them
+// during pod scheduling. They may also be resized up or down, to
+// accommodate
+// the workload.
+type NodePool struct {
+ // Autoscaling: Autoscaler configuration for this NodePool. Autoscaler
+ // is enabled
+ // only if a valid configuration is present.
+ Autoscaling *NodePoolAutoscaling `json:"autoscaling,omitempty"`
+
+ // Config: The node configuration of the pool.
+ Config *NodeConfig `json:"config,omitempty"`
+
+ // InitialNodeCount: The initial node count for the pool. You must
+ // ensure that your
+ // Compute Engine <a href="/compute/docs/resource-quotas">resource
+ // quota</a>
+ // is sufficient for this number of instances. You must also have
+ // available
+ // firewall and routes quota.
+ InitialNodeCount int64 `json:"initialNodeCount,omitempty"`
+
+ // InstanceGroupUrls: [Output only] The resource URLs of
+ // [instance
+ // groups](/compute/docs/instance-groups/) associated with this
+ // node pool.
+ InstanceGroupUrls []string `json:"instanceGroupUrls,omitempty"`
+
+ // Management: NodeManagement configuration for this NodePool.
+ Management *NodeManagement `json:"management,omitempty"`
+
+ // Name: The name of the node pool.
+ Name string `json:"name,omitempty"`
+
+ // SelfLink: [Output only] Server-defined URL for the resource.
+ SelfLink string `json:"selfLink,omitempty"`
+
+ // Status: [Output only] The status of the nodes in this pool instance.
+ //
+ // Possible values:
+ // "STATUS_UNSPECIFIED" - Not set.
+ // "PROVISIONING" - The PROVISIONING state indicates the node pool is
+ // being created.
+ // "RUNNING" - The RUNNING state indicates the node pool has been
+ // created
+ // and is fully usable.
+ // "RUNNING_WITH_ERROR" - The RUNNING_WITH_ERROR state indicates the
+ // node pool has been created
+ // and is partially usable. Some error state has occurred and
+ // some
+ // functionality may be impaired. Customer may need to reissue a
+ // request
+ // or trigger a new update.
+ // "RECONCILING" - The RECONCILING state indicates that some work is
+ // actively being done on
+ // the node pool, such as upgrading node software. Details can
+ // be found in the `statusMessage` field.
+ // "STOPPING" - The STOPPING state indicates the node pool is being
+ // deleted.
+ // "ERROR" - The ERROR state indicates the node pool may be unusable.
+ // Details
+ // can be found in the `statusMessage` field.
+ Status string `json:"status,omitempty"`
+
+ // StatusMessage: [Output only] Additional information about the current
+ // status of this
+ // node pool instance, if available.
+ StatusMessage string `json:"statusMessage,omitempty"`
+
+ // Version: [Output only] The version of the Kubernetes of this node.
+ Version string `json:"version,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Autoscaling") 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. "Autoscaling") 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 *NodePool) MarshalJSON() ([]byte, error) {
+ type noMethod NodePool
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// NodePoolAutoscaling: NodePoolAutoscaling contains information
+// required by cluster autoscaler to
+// adjust the size of the node pool to the current cluster usage.
+type NodePoolAutoscaling struct {
+ // Enabled: Is autoscaling enabled for this node pool.
+ Enabled bool `json:"enabled,omitempty"`
+
+ // MaxNodeCount: Maximum number of nodes in the NodePool. Must be >=
+ // min_node_count. There
+ // has to enough quota to scale up the cluster.
+ MaxNodeCount int64 `json:"maxNodeCount,omitempty"`
+
+ // MinNodeCount: Minimum number of nodes in the NodePool. Must be >= 1
+ // and <=
+ // max_node_count.
+ MinNodeCount int64 `json:"minNodeCount,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 []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 []string `json:"-"`
+}
+
+func (s *NodePoolAutoscaling) MarshalJSON() ([]byte, error) {
+ type noMethod NodePoolAutoscaling
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Operation: This operation resource represents operations that may
+// have happened or are
+// happening on the cluster. All fields are output only.
+type Operation struct {
+ // Detail: Detailed operation progress, if available.
+ Detail string `json:"detail,omitempty"`
+
+ // Location: [Output only] The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/regions-zones/regions-zones#available)
+ // or
+ // [region](/compute/docs/regions-zones/regions-zones#available) in
+ // which
+ // the cluster resides.
+ Location string `json:"location,omitempty"`
+
+ // Name: The server-assigned ID for the operation.
+ Name string `json:"name,omitempty"`
+
+ // OperationType: The operation type.
+ //
+ // Possible values:
+ // "TYPE_UNSPECIFIED" - Not set.
+ // "CREATE_CLUSTER" - Cluster create.
+ // "DELETE_CLUSTER" - Cluster delete.
+ // "UPGRADE_MASTER" - A master upgrade.
+ // "UPGRADE_NODES" - A node upgrade.
+ // "REPAIR_CLUSTER" - Cluster repair.
+ // "UPDATE_CLUSTER" - Cluster update.
+ // "CREATE_NODE_POOL" - Node pool create.
+ // "DELETE_NODE_POOL" - Node pool delete.
+ // "SET_NODE_POOL_MANAGEMENT" - Set node pool management.
+ // "AUTO_REPAIR_NODES" - Automatic node pool repair.
+ // "AUTO_UPGRADE_NODES" - Automatic node upgrade.
+ // "SET_LABELS" - Set labels.
+ // "SET_MASTER_AUTH" - Set/generate master auth materials
+ // "SET_NODE_POOL_SIZE" - Set node pool size.
+ // "SET_NETWORK_POLICY" - Updates network policy for a cluster.
+ OperationType string `json:"operationType,omitempty"`
+
+ // SelfLink: Server-defined URL for the resource.
+ SelfLink string `json:"selfLink,omitempty"`
+
+ // Status: The current status of the operation.
+ //
+ // Possible values:
+ // "STATUS_UNSPECIFIED" - Not set.
+ // "PENDING" - The operation has been created.
+ // "RUNNING" - The operation is currently running.
+ // "DONE" - The operation is done, either cancelled or completed.
+ // "ABORTING" - The operation is aborting.
+ Status string `json:"status,omitempty"`
+
+ // StatusMessage: If an error has occurred, a textual description of the
+ // error.
+ StatusMessage string `json:"statusMessage,omitempty"`
+
+ // TargetLink: Server-defined URL for the target of the operation.
+ TargetLink string `json:"targetLink,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the operation
+ // is taking place.
+ // This field is deprecated, use location instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Detail") 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. "Detail") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *Operation) MarshalJSON() ([]byte, error) {
+ type noMethod Operation
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// RollbackNodePoolUpgradeRequest: RollbackNodePoolUpgradeRequest
+// rollbacks the previously Aborted or Failed
+// NodePool upgrade. This will be an no-op if the last upgrade
+// successfully
+// completed.
+type RollbackNodePoolUpgradeRequest struct {
+ // ClusterId: The name of the cluster to rollback.
+ // This field is deprecated, use name instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // Name: The name (project, location, cluster, node pool id) of the node
+ // poll to
+ // rollback upgrade.
+ // Specified in the format
+ // 'projects/*/locations/*/clusters/*/nodePools/*'.
+ Name string `json:"name,omitempty"`
+
+ // NodePoolId: The name of the node pool to rollback.
+ // This field is deprecated, use name instead.
+ NodePoolId string `json:"nodePoolId,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://support.google.com/cloud/answer/6158840).
+ // This
+ // field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterId") 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. "ClusterId") 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 *RollbackNodePoolUpgradeRequest) MarshalJSON() ([]byte, error) {
+ type noMethod RollbackNodePoolUpgradeRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ServerConfig: Container Engine service configuration.
+type ServerConfig struct {
+ // DefaultClusterVersion: Version of Kubernetes the service deploys by
+ // default.
+ DefaultClusterVersion string `json:"defaultClusterVersion,omitempty"`
+
+ // DefaultImageType: Default image type.
+ DefaultImageType string `json:"defaultImageType,omitempty"`
+
+ // ValidImageTypes: List of valid image types.
+ ValidImageTypes []string `json:"validImageTypes,omitempty"`
+
+ // ValidMasterVersions: List of valid master versions.
+ ValidMasterVersions []string `json:"validMasterVersions,omitempty"`
+
+ // ValidNodeVersions: List of valid node upgrade target versions.
+ ValidNodeVersions []string `json:"validNodeVersions,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "DefaultClusterVersion") 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. "DefaultClusterVersion") 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 *ServerConfig) MarshalJSON() ([]byte, error) {
+ type noMethod ServerConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SetLabelsRequest: SetLabelsRequest sets the Google Cloud Platform
+// labels on a Google Container
+// Engine cluster, which will in turn set them for Google Compute
+// Engine
+// resources used by that cluster
+type SetLabelsRequest struct {
+ // ClusterId: The name of the cluster.
+ // This field is deprecated, use name instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // LabelFingerprint: The fingerprint of the previous set of labels for
+ // this resource,
+ // used to detect conflicts. The fingerprint is initially generated
+ // by
+ // Container 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 <code>get()</code> request to
+ // the
+ // resource to get the latest fingerprint.
+ LabelFingerprint string `json:"labelFingerprint,omitempty"`
+
+ // Name: The name (project, location, cluster id) of the cluster to set
+ // labels.
+ // Specified in the format 'projects/*/locations/*/clusters/*'.
+ Name string `json:"name,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://developers.google.com/console/help/new/#projec
+ // tnumber).
+ // This field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // ResourceLabels: The labels to set for that cluster.
+ ResourceLabels map[string]string `json:"resourceLabels,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterId") 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. "ClusterId") 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 *SetLabelsRequest) MarshalJSON() ([]byte, error) {
+ type noMethod SetLabelsRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SetLegacyAbacRequest: SetLegacyAbacRequest enables or disables the
+// ABAC authorization mechanism for
+// a cluster.
+type SetLegacyAbacRequest struct {
+ // ClusterId: The name of the cluster to update.
+ // This field is deprecated, use name instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // Enabled: Whether ABAC authorization will be enabled in the cluster.
+ Enabled bool `json:"enabled,omitempty"`
+
+ // Name: The name (project, location, cluster id) of the cluster to set
+ // legacy abac.
+ // Specified in the format 'projects/*/locations/*/clusters/*'.
+ Name string `json:"name,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://support.google.com/cloud/answer/6158840).
+ // This
+ // field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterId") 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. "ClusterId") 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 *SetLegacyAbacRequest) MarshalJSON() ([]byte, error) {
+ type noMethod SetLegacyAbacRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SetMasterAuthRequest: SetMasterAuthRequest updates the admin password
+// of a cluster.
+type SetMasterAuthRequest struct {
+ // Action: The exact form of action to be taken on the master auth
+ //
+ // Possible values:
+ // "UNKNOWN" - Operation is unknown and will error out
+ // "SET_PASSWORD" - Set the password to a user generated value.
+ // "GENERATE_PASSWORD" - Generate a new password and set it to that.
+ Action string `json:"action,omitempty"`
+
+ // ClusterId: The name of the cluster to upgrade.
+ // This field is deprecated, use name instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // Name: The name (project, location, cluster) of the cluster to set
+ // auth.
+ // Specified in the format 'projects/*/locations/*/clusters/*'.
+ Name string `json:"name,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://support.google.com/cloud/answer/6158840).
+ // This
+ // field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Update: A description of the update.
+ Update *MasterAuth `json:"update,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Action") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Action") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *SetMasterAuthRequest) MarshalJSON() ([]byte, error) {
+ type noMethod SetMasterAuthRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SetNetworkPolicyRequest: SetNetworkPolicyRequest enables/disables
+// network policy for a cluster.
+type SetNetworkPolicyRequest struct {
+ // ClusterId: The name of the cluster.
+ // This field is deprecated, use name instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // Name: The name (project, location, cluster id) of the cluster to set
+ // networking policy.
+ // Specified in the format 'projects/*/locations/*/clusters/*'.
+ Name string `json:"name,omitempty"`
+
+ // NetworkPolicy: Configuration options for the NetworkPolicy feature.
+ NetworkPolicy *NetworkPolicy `json:"networkPolicy,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://developers.google.com/console/help/new/#projec
+ // tnumber).
+ // This field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterId") 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. "ClusterId") 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 *SetNetworkPolicyRequest) MarshalJSON() ([]byte, error) {
+ type noMethod SetNetworkPolicyRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SetNodePoolManagementRequest: SetNodePoolManagementRequest sets the
+// node management properties of a node
+// pool.
+type SetNodePoolManagementRequest struct {
+ // ClusterId: The name of the cluster to update.
+ // This field is deprecated, use name instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // Management: NodeManagement configuration for the node pool.
+ Management *NodeManagement `json:"management,omitempty"`
+
+ // Name: The name (project, location, cluster, node pool id) of the node
+ // pool to set
+ // management properties. Specified in the
+ // format
+ // 'projects/*/locations/*/clusters/*/nodePools/*'.
+ Name string `json:"name,omitempty"`
+
+ // NodePoolId: The name of the node pool to update.
+ // This field is deprecated, use name instead.
+ NodePoolId string `json:"nodePoolId,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://support.google.com/cloud/answer/6158840).
+ // This
+ // field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterId") 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. "ClusterId") 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 *SetNodePoolManagementRequest) MarshalJSON() ([]byte, error) {
+ type noMethod SetNodePoolManagementRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// StartIPRotationRequest: StartIPRotationRequest creates a new IP for
+// the cluster and then performs
+// a node upgrade on each node pool to point to the new IP.
+type StartIPRotationRequest struct {
+ // ClusterId: The name of the cluster.
+ // This field is deprecated, use name instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // Name: The name (project, location, cluster id) of the cluster to
+ // start IP rotation.
+ // Specified in the format 'projects/*/locations/*/clusters/*'.
+ Name string `json:"name,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://developers.google.com/console/help/new/#projec
+ // tnumber).
+ // This field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterId") 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. "ClusterId") 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 *StartIPRotationRequest) MarshalJSON() ([]byte, error) {
+ type noMethod StartIPRotationRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// UpdateClusterRequest: UpdateClusterRequest updates the settings of a
+// cluster.
+type UpdateClusterRequest struct {
+ // ClusterId: The name of the cluster to upgrade.
+ // This field is deprecated, use name instead.
+ ClusterId string `json:"clusterId,omitempty"`
+
+ // Name: The name (project, location, cluster) of the cluster to
+ // update.
+ // Specified in the format 'projects/*/locations/*/clusters/*'.
+ Name string `json:"name,omitempty"`
+
+ // ProjectId: The Google Developers Console [project ID or
+ // project
+ // number](https://support.google.com/cloud/answer/6158840).
+ // This
+ // field is deprecated, use name instead.
+ ProjectId string `json:"projectId,omitempty"`
+
+ // Update: A description of the update.
+ Update *ClusterUpdate `json:"update,omitempty"`
+
+ // Zone: The name of the Google Compute
+ // Engine
+ // [zone](/compute/docs/zones#available) in which the
+ // cluster
+ // resides.
+ // This field is deprecated, use name instead.
+ Zone string `json:"zone,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ClusterId") 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. "ClusterId") 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 *UpdateClusterRequest) MarshalJSON() ([]byte, error) {
+ type noMethod UpdateClusterRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// method id "container.projects.locations.getServerConfig":
+
+type ProjectsLocationsGetServerConfigCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetServerConfig: Returns configuration info about the Container
+// Engine service.
+func (r *ProjectsLocationsService) GetServerConfig(name string) *ProjectsLocationsGetServerConfigCall {
+ c := &ProjectsLocationsGetServerConfigCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The Google
+// Developers Console [project ID or
+// project
+// number](https://support.google.com/cloud/answer/6158840).
+// This
+// field is deprecated, use name instead.
+func (c *ProjectsLocationsGetServerConfigCall) ProjectId(projectId string) *ProjectsLocationsGetServerConfigCall {
+ c.urlParams_.Set("projectId", projectId)
+ return c
+}
+
+// Zone sets the optional parameter "zone": The name of the Google
+// Compute Engine [zone](/compute/docs/zones#available)
+// to return operations for.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsGetServerConfigCall) Zone(zone string) *ProjectsLocationsGetServerConfigCall {
+ c.urlParams_.Set("zone", zone)
+ 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 *ProjectsLocationsGetServerConfigCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetServerConfigCall {
+ 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 *ProjectsLocationsGetServerConfigCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetServerConfigCall {
+ 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 *ProjectsLocationsGetServerConfigCall) Context(ctx context.Context) *ProjectsLocationsGetServerConfigCall {
+ 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 *ProjectsLocationsGetServerConfigCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsGetServerConfigCall) 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, "v1beta1/{+name}/serverConfig")
+ 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 "container.projects.locations.getServerConfig" call.
+// Exactly one of *ServerConfig or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *ServerConfig.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 *ProjectsLocationsGetServerConfigCall) Do(opts ...googleapi.CallOption) (*ServerConfig, 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 := &ServerConfig{
+ 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 configuration info about the Container Engine service.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
+ // "httpMethod": "GET",
+ // "id": "container.projects.locations.getServerConfig",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}/serverConfig",
+ // "response": {
+ // "$ref": "ServerConfig"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.completeIpRotation":
+
+type ProjectsLocationsClustersCompleteIpRotationCall struct {
+ s *Service
+ name string
+ completeiprotationrequest *CompleteIPRotationRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// CompleteIpRotation: Completes master IP rotation.
+func (r *ProjectsLocationsClustersService) CompleteIpRotation(name string, completeiprotationrequest *CompleteIPRotationRequest) *ProjectsLocationsClustersCompleteIpRotationCall {
+ c := &ProjectsLocationsClustersCompleteIpRotationCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.completeiprotationrequest = completeiprotationrequest
+ 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 *ProjectsLocationsClustersCompleteIpRotationCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersCompleteIpRotationCall {
+ 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 *ProjectsLocationsClustersCompleteIpRotationCall) Context(ctx context.Context) *ProjectsLocationsClustersCompleteIpRotationCall {
+ 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 *ProjectsLocationsClustersCompleteIpRotationCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersCompleteIpRotationCall) 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.completeiprotationrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}:completeIpRotation")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.completeIpRotation" 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 *ProjectsLocationsClustersCompleteIpRotationCall) 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": "Completes master IP rotation.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.completeIpRotation",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}:completeIpRotation",
+ // "request": {
+ // "$ref": "CompleteIPRotationRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.create":
+
+type ProjectsLocationsClustersCreateCall struct {
+ s *Service
+ parent string
+ createclusterrequest *CreateClusterRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a cluster, consisting of the specified number and
+// type of Google
+// Compute Engine instances.
+//
+// By default, the cluster is created in the project's
+// [default
+// network](/compute/docs/networks-and-firewalls#networks).
+//
+// One firewall is added for the cluster. After cluster creation,
+// the cluster creates routes for each node to allow the containers
+// on that node to communicate with all other instances in
+// the
+// cluster.
+//
+// Finally, an entry is added to the project's global metadata
+// indicating
+// which CIDR range is being used by the cluster.
+func (r *ProjectsLocationsClustersService) Create(parent string, createclusterrequest *CreateClusterRequest) *ProjectsLocationsClustersCreateCall {
+ c := &ProjectsLocationsClustersCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.createclusterrequest = createclusterrequest
+ 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 *ProjectsLocationsClustersCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersCreateCall {
+ 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 *ProjectsLocationsClustersCreateCall) Context(ctx context.Context) *ProjectsLocationsClustersCreateCall {
+ 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 *ProjectsLocationsClustersCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersCreateCall) 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.createclusterrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+parent}/clusters")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.create" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *ProjectsLocationsClustersCreateCall) 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 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": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+parent}/clusters",
+ // "request": {
+ // "$ref": "CreateClusterRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.delete":
+
+type ProjectsLocationsClustersDeleteCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes the cluster, including the Kubernetes endpoint and
+// all worker
+// nodes.
+//
+// Firewalls and routes that were configured during cluster creation
+// are also deleted.
+//
+// Other Google Compute Engine resources that might be in use by the
+// cluster
+// (e.g. load balancer resources) will not be deleted if they weren't
+// present
+// at the initial create time.
+func (r *ProjectsLocationsClustersService) Delete(name string) *ProjectsLocationsClustersDeleteCall {
+ c := &ProjectsLocationsClustersDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// ClusterId sets the optional parameter "clusterId": The name of the
+// cluster to delete.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersDeleteCall) ClusterId(clusterId string) *ProjectsLocationsClustersDeleteCall {
+ c.urlParams_.Set("clusterId", clusterId)
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The Google
+// Developers Console [project ID or
+// project
+// number](https://support.google.com/cloud/answer/6158840).
+// This
+// field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersDeleteCall) ProjectId(projectId string) *ProjectsLocationsClustersDeleteCall {
+ c.urlParams_.Set("projectId", projectId)
+ return c
+}
+
+// Zone sets the optional parameter "zone": The name of the Google
+// Compute Engine
+// [zone](/compute/docs/zones#available) in which the
+// cluster
+// resides.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersDeleteCall) Zone(zone string) *ProjectsLocationsClustersDeleteCall {
+ c.urlParams_.Set("zone", zone)
+ 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 *ProjectsLocationsClustersDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersDeleteCall {
+ 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 *ProjectsLocationsClustersDeleteCall) Context(ctx context.Context) *ProjectsLocationsClustersDeleteCall {
+ 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 *ProjectsLocationsClustersDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersDeleteCall) 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, "v1beta1/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.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 *ProjectsLocationsClustersDeleteCall) 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 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.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ // "httpMethod": "DELETE",
+ // "id": "container.projects.locations.clusters.delete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.get":
+
+type ProjectsLocationsClustersGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Gets the details of a specific cluster.
+func (r *ProjectsLocationsClustersService) Get(name string) *ProjectsLocationsClustersGetCall {
+ c := &ProjectsLocationsClustersGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// ClusterId sets the optional parameter "clusterId": The name of the
+// cluster to retrieve.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersGetCall) ClusterId(clusterId string) *ProjectsLocationsClustersGetCall {
+ c.urlParams_.Set("clusterId", clusterId)
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The Google
+// Developers Console [project ID or
+// project
+// number](https://support.google.com/cloud/answer/6158840).
+// This
+// field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersGetCall) ProjectId(projectId string) *ProjectsLocationsClustersGetCall {
+ c.urlParams_.Set("projectId", projectId)
+ return c
+}
+
+// Zone sets the optional parameter "zone": The name of the Google
+// Compute Engine
+// [zone](/compute/docs/zones#available) in which the
+// cluster
+// resides.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersGetCall) Zone(zone string) *ProjectsLocationsClustersGetCall {
+ c.urlParams_.Set("zone", zone)
+ 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 *ProjectsLocationsClustersGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersGetCall {
+ 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 *ProjectsLocationsClustersGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsClustersGetCall {
+ 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 *ProjectsLocationsClustersGetCall) Context(ctx context.Context) *ProjectsLocationsClustersGetCall {
+ 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 *ProjectsLocationsClustersGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersGetCall) 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, "v1beta1/{+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 "container.projects.locations.clusters.get" call.
+// Exactly one of *Cluster or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Cluster.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 *ProjectsLocationsClustersGetCall) Do(opts ...googleapi.CallOption) (*Cluster, 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 := &Cluster{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Gets the details of a specific cluster.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ // "httpMethod": "GET",
+ // "id": "container.projects.locations.clusters.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}",
+ // "response": {
+ // "$ref": "Cluster"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.list":
+
+type ProjectsLocationsClustersListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists all clusters owned by a project in either the specified
+// zone or all
+// zones.
+func (r *ProjectsLocationsClustersService) List(parent string) *ProjectsLocationsClustersListCall {
+ c := &ProjectsLocationsClustersListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The Google
+// Developers Console [project ID or
+// project
+// number](https://support.google.com/cloud/answer/6158840).
+// This
+// field is deprecated, use parent instead.
+func (c *ProjectsLocationsClustersListCall) ProjectId(projectId string) *ProjectsLocationsClustersListCall {
+ c.urlParams_.Set("projectId", projectId)
+ return c
+}
+
+// Zone sets the optional parameter "zone": The name of the Google
+// Compute Engine
+// [zone](/compute/docs/zones#available) in which the cluster
+// resides, or "-" for all zones.
+// This field is deprecated, use parent instead.
+func (c *ProjectsLocationsClustersListCall) Zone(zone string) *ProjectsLocationsClustersListCall {
+ c.urlParams_.Set("zone", zone)
+ 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 *ProjectsLocationsClustersListCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersListCall {
+ 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 *ProjectsLocationsClustersListCall) IfNoneMatch(entityTag string) *ProjectsLocationsClustersListCall {
+ 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 *ProjectsLocationsClustersListCall) Context(ctx context.Context) *ProjectsLocationsClustersListCall {
+ 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 *ProjectsLocationsClustersListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersListCall) 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, "v1beta1/{+parent}/clusters")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.list" call.
+// Exactly one of *ListClustersResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListClustersResponse.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 *ProjectsLocationsClustersListCall) Do(opts ...googleapi.CallOption) (*ListClustersResponse, 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 := &ListClustersResponse{
+ 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 all clusters owned by a project in either the specified zone or all\nzones.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ // "httpMethod": "GET",
+ // "id": "container.projects.locations.clusters.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+parent}/clusters",
+ // "response": {
+ // "$ref": "ListClustersResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.setLegacyAbac":
+
+type ProjectsLocationsClustersSetLegacyAbacCall struct {
+ s *Service
+ name string
+ setlegacyabacrequest *SetLegacyAbacRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetLegacyAbac: Enables or disables the ABAC authorization mechanism
+// on a cluster.
+func (r *ProjectsLocationsClustersService) SetLegacyAbac(name string, setlegacyabacrequest *SetLegacyAbacRequest) *ProjectsLocationsClustersSetLegacyAbacCall {
+ c := &ProjectsLocationsClustersSetLegacyAbacCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.setlegacyabacrequest = setlegacyabacrequest
+ 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 *ProjectsLocationsClustersSetLegacyAbacCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersSetLegacyAbacCall {
+ 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 *ProjectsLocationsClustersSetLegacyAbacCall) Context(ctx context.Context) *ProjectsLocationsClustersSetLegacyAbacCall {
+ 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 *ProjectsLocationsClustersSetLegacyAbacCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersSetLegacyAbacCall) 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.setlegacyabacrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}:setLegacyAbac")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.setLegacyAbac" 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 *ProjectsLocationsClustersSetLegacyAbacCall) 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": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.setLegacyAbac",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}:setLegacyAbac",
+ // "request": {
+ // "$ref": "SetLegacyAbacRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.setMasterAuth":
+
+type ProjectsLocationsClustersSetMasterAuthCall struct {
+ s *Service
+ name string
+ setmasterauthrequest *SetMasterAuthRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetMasterAuth: Used to set master auth materials. Currently supports
+// :-
+// Changing the admin password of a specific cluster.
+// This can be either via password generation or explicitly set.
+// Modify basic_auth.csv and reset the K8S API server.
+func (r *ProjectsLocationsClustersService) SetMasterAuth(name string, setmasterauthrequest *SetMasterAuthRequest) *ProjectsLocationsClustersSetMasterAuthCall {
+ c := &ProjectsLocationsClustersSetMasterAuthCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.setmasterauthrequest = setmasterauthrequest
+ 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 *ProjectsLocationsClustersSetMasterAuthCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersSetMasterAuthCall {
+ 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 *ProjectsLocationsClustersSetMasterAuthCall) Context(ctx context.Context) *ProjectsLocationsClustersSetMasterAuthCall {
+ 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 *ProjectsLocationsClustersSetMasterAuthCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersSetMasterAuthCall) 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.setmasterauthrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}:setMasterAuth")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.setMasterAuth" 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 *ProjectsLocationsClustersSetMasterAuthCall) 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": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.setMasterAuth",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}:setMasterAuth",
+ // "request": {
+ // "$ref": "SetMasterAuthRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.setNetworkPolicy":
+
+type ProjectsLocationsClustersSetNetworkPolicyCall struct {
+ s *Service
+ name string
+ setnetworkpolicyrequest *SetNetworkPolicyRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetNetworkPolicy: Enables/Disables Network Policy for a cluster.
+func (r *ProjectsLocationsClustersService) SetNetworkPolicy(name string, setnetworkpolicyrequest *SetNetworkPolicyRequest) *ProjectsLocationsClustersSetNetworkPolicyCall {
+ c := &ProjectsLocationsClustersSetNetworkPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.setnetworkpolicyrequest = setnetworkpolicyrequest
+ 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 *ProjectsLocationsClustersSetNetworkPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersSetNetworkPolicyCall {
+ 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 *ProjectsLocationsClustersSetNetworkPolicyCall) Context(ctx context.Context) *ProjectsLocationsClustersSetNetworkPolicyCall {
+ 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 *ProjectsLocationsClustersSetNetworkPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersSetNetworkPolicyCall) 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.setnetworkpolicyrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}:setNetworkPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.setNetworkPolicy" 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 *ProjectsLocationsClustersSetNetworkPolicyCall) 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": "Enables/Disables Network Policy for a cluster.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.setNetworkPolicy",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}:setNetworkPolicy",
+ // "request": {
+ // "$ref": "SetNetworkPolicyRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.setResourceLabels":
+
+type ProjectsLocationsClustersSetResourceLabelsCall struct {
+ s *Service
+ name string
+ setlabelsrequest *SetLabelsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetResourceLabels: Sets labels on a cluster.
+func (r *ProjectsLocationsClustersService) SetResourceLabels(name string, setlabelsrequest *SetLabelsRequest) *ProjectsLocationsClustersSetResourceLabelsCall {
+ c := &ProjectsLocationsClustersSetResourceLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.setlabelsrequest = setlabelsrequest
+ 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 *ProjectsLocationsClustersSetResourceLabelsCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersSetResourceLabelsCall {
+ 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 *ProjectsLocationsClustersSetResourceLabelsCall) Context(ctx context.Context) *ProjectsLocationsClustersSetResourceLabelsCall {
+ 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 *ProjectsLocationsClustersSetResourceLabelsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersSetResourceLabelsCall) 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.setlabelsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}:setResourceLabels")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.setResourceLabels" 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 *ProjectsLocationsClustersSetResourceLabelsCall) 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 a cluster.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.setResourceLabels",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}:setResourceLabels",
+ // "request": {
+ // "$ref": "SetLabelsRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.startIpRotation":
+
+type ProjectsLocationsClustersStartIpRotationCall struct {
+ s *Service
+ name string
+ startiprotationrequest *StartIPRotationRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// StartIpRotation: Start master IP rotation.
+func (r *ProjectsLocationsClustersService) StartIpRotation(name string, startiprotationrequest *StartIPRotationRequest) *ProjectsLocationsClustersStartIpRotationCall {
+ c := &ProjectsLocationsClustersStartIpRotationCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.startiprotationrequest = startiprotationrequest
+ 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 *ProjectsLocationsClustersStartIpRotationCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersStartIpRotationCall {
+ 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 *ProjectsLocationsClustersStartIpRotationCall) Context(ctx context.Context) *ProjectsLocationsClustersStartIpRotationCall {
+ 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 *ProjectsLocationsClustersStartIpRotationCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersStartIpRotationCall) 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.startiprotationrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}:startIpRotation")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.startIpRotation" 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 *ProjectsLocationsClustersStartIpRotationCall) 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": "Start master IP rotation.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.startIpRotation",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}:startIpRotation",
+ // "request": {
+ // "$ref": "StartIPRotationRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.update":
+
+type ProjectsLocationsClustersUpdateCall struct {
+ s *Service
+ name string
+ updateclusterrequest *UpdateClusterRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Update: Updates the settings of a specific cluster.
+func (r *ProjectsLocationsClustersService) Update(name string, updateclusterrequest *UpdateClusterRequest) *ProjectsLocationsClustersUpdateCall {
+ c := &ProjectsLocationsClustersUpdateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.updateclusterrequest = updateclusterrequest
+ 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 *ProjectsLocationsClustersUpdateCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersUpdateCall {
+ 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 *ProjectsLocationsClustersUpdateCall) Context(ctx context.Context) *ProjectsLocationsClustersUpdateCall {
+ 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 *ProjectsLocationsClustersUpdateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersUpdateCall) 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.updateclusterrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PUT", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.update" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *ProjectsLocationsClustersUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Operation{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Updates the settings of a specific cluster.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ // "httpMethod": "PUT",
+ // "id": "container.projects.locations.clusters.update",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}",
+ // "request": {
+ // "$ref": "UpdateClusterRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.nodePools.create":
+
+type ProjectsLocationsClustersNodePoolsCreateCall struct {
+ s *Service
+ parent string
+ createnodepoolrequest *CreateNodePoolRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a node pool for a cluster.
+func (r *ProjectsLocationsClustersNodePoolsService) Create(parent string, createnodepoolrequest *CreateNodePoolRequest) *ProjectsLocationsClustersNodePoolsCreateCall {
+ c := &ProjectsLocationsClustersNodePoolsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.createnodepoolrequest = createnodepoolrequest
+ 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 *ProjectsLocationsClustersNodePoolsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersNodePoolsCreateCall {
+ 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 *ProjectsLocationsClustersNodePoolsCreateCall) Context(ctx context.Context) *ProjectsLocationsClustersNodePoolsCreateCall {
+ 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 *ProjectsLocationsClustersNodePoolsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersNodePoolsCreateCall) 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.createnodepoolrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+parent}/nodePools")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.nodePools.create" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *ProjectsLocationsClustersNodePoolsCreateCall) 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 node pool for a cluster.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.nodePools.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+parent}/nodePools",
+ // "request": {
+ // "$ref": "CreateNodePoolRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.nodePools.delete":
+
+type ProjectsLocationsClustersNodePoolsDeleteCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes a node pool from a cluster.
+func (r *ProjectsLocationsClustersNodePoolsService) Delete(name string) *ProjectsLocationsClustersNodePoolsDeleteCall {
+ c := &ProjectsLocationsClustersNodePoolsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// ClusterId sets the optional parameter "clusterId": The name of the
+// cluster.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersNodePoolsDeleteCall) ClusterId(clusterId string) *ProjectsLocationsClustersNodePoolsDeleteCall {
+ c.urlParams_.Set("clusterId", clusterId)
+ return c
+}
+
+// NodePoolId sets the optional parameter "nodePoolId": The name of the
+// node pool to delete.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersNodePoolsDeleteCall) NodePoolId(nodePoolId string) *ProjectsLocationsClustersNodePoolsDeleteCall {
+ c.urlParams_.Set("nodePoolId", nodePoolId)
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The Google
+// Developers Console [project ID or
+// project
+// number](https://developers.google.com/console/help/new/#projec
+// tnumber).
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersNodePoolsDeleteCall) ProjectId(projectId string) *ProjectsLocationsClustersNodePoolsDeleteCall {
+ c.urlParams_.Set("projectId", projectId)
+ return c
+}
+
+// Zone sets the optional parameter "zone": The name of the Google
+// Compute Engine
+// [zone](/compute/docs/zones#available) in which the
+// cluster
+// resides.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersNodePoolsDeleteCall) Zone(zone string) *ProjectsLocationsClustersNodePoolsDeleteCall {
+ c.urlParams_.Set("zone", zone)
+ 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 *ProjectsLocationsClustersNodePoolsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersNodePoolsDeleteCall {
+ 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 *ProjectsLocationsClustersNodePoolsDeleteCall) Context(ctx context.Context) *ProjectsLocationsClustersNodePoolsDeleteCall {
+ 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 *ProjectsLocationsClustersNodePoolsDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersNodePoolsDeleteCall) 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, "v1beta1/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.nodePools.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 *ProjectsLocationsClustersNodePoolsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Operation{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Deletes a node pool from a cluster.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
+ // "httpMethod": "DELETE",
+ // "id": "container.projects.locations.clusters.nodePools.delete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "nodePoolId": {
+ // "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.nodePools.get":
+
+type ProjectsLocationsClustersNodePoolsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Retrieves the node pool requested.
+func (r *ProjectsLocationsClustersNodePoolsService) Get(name string) *ProjectsLocationsClustersNodePoolsGetCall {
+ c := &ProjectsLocationsClustersNodePoolsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// ClusterId sets the optional parameter "clusterId": The name of the
+// cluster.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersNodePoolsGetCall) ClusterId(clusterId string) *ProjectsLocationsClustersNodePoolsGetCall {
+ c.urlParams_.Set("clusterId", clusterId)
+ return c
+}
+
+// NodePoolId sets the optional parameter "nodePoolId": The name of the
+// node pool.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersNodePoolsGetCall) NodePoolId(nodePoolId string) *ProjectsLocationsClustersNodePoolsGetCall {
+ c.urlParams_.Set("nodePoolId", nodePoolId)
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The Google
+// Developers Console [project ID or
+// project
+// number](https://developers.google.com/console/help/new/#projec
+// tnumber).
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersNodePoolsGetCall) ProjectId(projectId string) *ProjectsLocationsClustersNodePoolsGetCall {
+ c.urlParams_.Set("projectId", projectId)
+ return c
+}
+
+// Zone sets the optional parameter "zone": The name of the Google
+// Compute Engine
+// [zone](/compute/docs/zones#available) in which the
+// cluster
+// resides.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsClustersNodePoolsGetCall) Zone(zone string) *ProjectsLocationsClustersNodePoolsGetCall {
+ c.urlParams_.Set("zone", zone)
+ 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 *ProjectsLocationsClustersNodePoolsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersNodePoolsGetCall {
+ 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 *ProjectsLocationsClustersNodePoolsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsClustersNodePoolsGetCall {
+ 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 *ProjectsLocationsClustersNodePoolsGetCall) Context(ctx context.Context) *ProjectsLocationsClustersNodePoolsGetCall {
+ 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 *ProjectsLocationsClustersNodePoolsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersNodePoolsGetCall) 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, "v1beta1/{+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 "container.projects.locations.clusters.nodePools.get" call.
+// Exactly one of *NodePool or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *NodePool.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 *ProjectsLocationsClustersNodePoolsGetCall) Do(opts ...googleapi.CallOption) (*NodePool, 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 := &NodePool{
+ 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 node pool requested.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
+ // "httpMethod": "GET",
+ // "id": "container.projects.locations.clusters.nodePools.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "nodePoolId": {
+ // "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}",
+ // "response": {
+ // "$ref": "NodePool"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.nodePools.list":
+
+type ProjectsLocationsClustersNodePoolsListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists the node pools for a cluster.
+func (r *ProjectsLocationsClustersNodePoolsService) List(parent string) *ProjectsLocationsClustersNodePoolsListCall {
+ c := &ProjectsLocationsClustersNodePoolsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// ClusterId sets the optional parameter "clusterId": The name of the
+// cluster.
+// This field is deprecated, use parent instead.
+func (c *ProjectsLocationsClustersNodePoolsListCall) ClusterId(clusterId string) *ProjectsLocationsClustersNodePoolsListCall {
+ c.urlParams_.Set("clusterId", clusterId)
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The Google
+// Developers Console [project ID or
+// project
+// number](https://developers.google.com/console/help/new/#projec
+// tnumber).
+// This field is deprecated, use parent instead.
+func (c *ProjectsLocationsClustersNodePoolsListCall) ProjectId(projectId string) *ProjectsLocationsClustersNodePoolsListCall {
+ c.urlParams_.Set("projectId", projectId)
+ return c
+}
+
+// Zone sets the optional parameter "zone": The name of the Google
+// Compute Engine
+// [zone](/compute/docs/zones#available) in which the
+// cluster
+// resides.
+// This field is deprecated, use parent instead.
+func (c *ProjectsLocationsClustersNodePoolsListCall) Zone(zone string) *ProjectsLocationsClustersNodePoolsListCall {
+ c.urlParams_.Set("zone", zone)
+ 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 *ProjectsLocationsClustersNodePoolsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersNodePoolsListCall {
+ 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 *ProjectsLocationsClustersNodePoolsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsClustersNodePoolsListCall {
+ 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 *ProjectsLocationsClustersNodePoolsListCall) Context(ctx context.Context) *ProjectsLocationsClustersNodePoolsListCall {
+ 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 *ProjectsLocationsClustersNodePoolsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersNodePoolsListCall) 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, "v1beta1/{+parent}/nodePools")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.nodePools.list" call.
+// Exactly one of *ListNodePoolsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListNodePoolsResponse.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 *ProjectsLocationsClustersNodePoolsListCall) Do(opts ...googleapi.CallOption) (*ListNodePoolsResponse, 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 := &ListNodePoolsResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Lists the node pools for a cluster.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ // "httpMethod": "GET",
+ // "id": "container.projects.locations.clusters.nodePools.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+parent}/nodePools",
+ // "response": {
+ // "$ref": "ListNodePoolsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.nodePools.rollback":
+
+type ProjectsLocationsClustersNodePoolsRollbackCall struct {
+ s *Service
+ name string
+ rollbacknodepoolupgraderequest *RollbackNodePoolUpgradeRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Rollback: Roll back the previously Aborted or Failed NodePool
+// upgrade.
+// This will be an no-op if the last upgrade successfully completed.
+func (r *ProjectsLocationsClustersNodePoolsService) Rollback(name string, rollbacknodepoolupgraderequest *RollbackNodePoolUpgradeRequest) *ProjectsLocationsClustersNodePoolsRollbackCall {
+ c := &ProjectsLocationsClustersNodePoolsRollbackCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.rollbacknodepoolupgraderequest = rollbacknodepoolupgraderequest
+ 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 *ProjectsLocationsClustersNodePoolsRollbackCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersNodePoolsRollbackCall {
+ 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 *ProjectsLocationsClustersNodePoolsRollbackCall) Context(ctx context.Context) *ProjectsLocationsClustersNodePoolsRollbackCall {
+ 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 *ProjectsLocationsClustersNodePoolsRollbackCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersNodePoolsRollbackCall) 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.rollbacknodepoolupgraderequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}:rollback")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.nodePools.rollback" 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 *ProjectsLocationsClustersNodePoolsRollbackCall) 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": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.nodePools.rollback",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}:rollback",
+ // "request": {
+ // "$ref": "RollbackNodePoolUpgradeRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.clusters.nodePools.setManagement":
+
+type ProjectsLocationsClustersNodePoolsSetManagementCall struct {
+ s *Service
+ name string
+ setnodepoolmanagementrequest *SetNodePoolManagementRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetManagement: Sets the NodeManagement options for a node pool.
+func (r *ProjectsLocationsClustersNodePoolsService) SetManagement(name string, setnodepoolmanagementrequest *SetNodePoolManagementRequest) *ProjectsLocationsClustersNodePoolsSetManagementCall {
+ c := &ProjectsLocationsClustersNodePoolsSetManagementCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.setnodepoolmanagementrequest = setnodepoolmanagementrequest
+ 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 *ProjectsLocationsClustersNodePoolsSetManagementCall) Fields(s ...googleapi.Field) *ProjectsLocationsClustersNodePoolsSetManagementCall {
+ 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 *ProjectsLocationsClustersNodePoolsSetManagementCall) Context(ctx context.Context) *ProjectsLocationsClustersNodePoolsSetManagementCall {
+ 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 *ProjectsLocationsClustersNodePoolsSetManagementCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsClustersNodePoolsSetManagementCall) 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.setnodepoolmanagementrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}:setManagement")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.clusters.nodePools.setManagement" 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 *ProjectsLocationsClustersNodePoolsSetManagementCall) 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 NodeManagement options for a node pool.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.clusters.nodePools.setManagement",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}:setManagement",
+ // "request": {
+ // "$ref": "SetNodePoolManagementRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.operations.cancel":
+
+type ProjectsLocationsOperationsCancelCall struct {
+ s *Service
+ name string
+ canceloperationrequest *CancelOperationRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Cancel: Cancels the specified operation.
+func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall {
+ c := &ProjectsLocationsOperationsCancelCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.canceloperationrequest = canceloperationrequest
+ 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 *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall {
+ 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 *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall {
+ 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 *ProjectsLocationsOperationsCancelCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsOperationsCancelCall) 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.canceloperationrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+name}:cancel")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.operations.cancel" call.
+// Exactly one of *Empty or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Empty.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Empty{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Cancels the specified operation.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+ // "httpMethod": "POST",
+ // "id": "container.projects.locations.operations.cancel",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}:cancel",
+ // "request": {
+ // "$ref": "CancelOperationRequest"
+ // },
+ // "response": {
+ // "$ref": "Empty"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.operations.get":
+
+type ProjectsLocationsOperationsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Gets the specified operation.
+func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall {
+ c := &ProjectsLocationsOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// OperationId sets the optional parameter "operationId": The
+// server-assigned `name` of the operation.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsOperationsGetCall) OperationId(operationId string) *ProjectsLocationsOperationsGetCall {
+ c.urlParams_.Set("operationId", operationId)
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The Google
+// Developers Console [project ID or
+// project
+// number](https://support.google.com/cloud/answer/6158840).
+// This
+// field is deprecated, use name instead.
+func (c *ProjectsLocationsOperationsGetCall) ProjectId(projectId string) *ProjectsLocationsOperationsGetCall {
+ c.urlParams_.Set("projectId", projectId)
+ return c
+}
+
+// Zone sets the optional parameter "zone": The name of the Google
+// Compute Engine
+// [zone](/compute/docs/zones#available) in which the
+// cluster
+// resides.
+// This field is deprecated, use name instead.
+func (c *ProjectsLocationsOperationsGetCall) Zone(zone string) *ProjectsLocationsOperationsGetCall {
+ c.urlParams_.Set("zone", zone)
+ 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 *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall {
+ 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 *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall {
+ 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 *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall {
+ 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 *ProjectsLocationsOperationsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsOperationsGetCall) 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, "v1beta1/{+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 "container.projects.locations.operations.get" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Operation{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Gets the specified operation.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+ // "httpMethod": "GET",
+ // "id": "container.projects.locations.operations.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "operationId": {
+ // "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+name}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.locations.operations.list":
+
+type ProjectsLocationsOperationsListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists all operations in a project in a specific zone or all
+// zones.
+func (r *ProjectsLocationsOperationsService) List(parent string) *ProjectsLocationsOperationsListCall {
+ c := &ProjectsLocationsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The Google
+// Developers Console [project ID or
+// project
+// number](https://support.google.com/cloud/answer/6158840).
+// This
+// field is deprecated, use parent instead.
+func (c *ProjectsLocationsOperationsListCall) ProjectId(projectId string) *ProjectsLocationsOperationsListCall {
+ c.urlParams_.Set("projectId", projectId)
+ return c
+}
+
+// Zone sets the optional parameter "zone": The name of the Google
+// Compute Engine [zone](/compute/docs/zones#available)
+// to return operations for, or `-` for all zones.
+// This field is deprecated, use parent instead.
+func (c *ProjectsLocationsOperationsListCall) Zone(zone string) *ProjectsLocationsOperationsListCall {
+ c.urlParams_.Set("zone", zone)
+ 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 *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall {
+ 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 *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall {
+ 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 *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall {
+ 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 *ProjectsLocationsOperationsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsOperationsListCall) 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, "v1beta1/{+parent}/operations")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.locations.operations.list" call.
+// Exactly one of *ListOperationsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListOperationsResponse.ServerResponse.Header or (if a response was
+// returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &ListOperationsResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Lists all operations in a project in a specific zone or all zones.",
+ // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
+ // "httpMethod": "GET",
+ // "id": "container.projects.locations.operations.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+parent}/operations",
+ // "response": {
+ // "$ref": "ListOperationsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.getServerconfig":
+
+type ProjectsZonesGetServerconfigCall struct {
+ s *Service
+ projectId string
+ zone string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetServerconfig: Returns configuration info about the Container
+// Engine service.
+func (r *ProjectsZonesService) GetServerconfig(projectId string, zone string) *ProjectsZonesGetServerconfigCall {
+ c := &ProjectsZonesGetServerconfigCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ return c
+}
+
+// Name sets the optional parameter "name": The name (project and
+// location) of the server config to get
+// Specified in the format 'projects/*/locations/*'.
+func (c *ProjectsZonesGetServerconfigCall) Name(name string) *ProjectsZonesGetServerconfigCall {
+ c.urlParams_.Set("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 *ProjectsZonesGetServerconfigCall) Fields(s ...googleapi.Field) *ProjectsZonesGetServerconfigCall {
+ 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 *ProjectsZonesGetServerconfigCall) IfNoneMatch(entityTag string) *ProjectsZonesGetServerconfigCall {
+ 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 *ProjectsZonesGetServerconfigCall) Context(ctx context.Context) *ProjectsZonesGetServerconfigCall {
+ 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 *ProjectsZonesGetServerconfigCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesGetServerconfigCall) 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, "v1beta1/projects/{projectId}/zones/{zone}/serverconfig")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.getServerconfig" call.
+// Exactly one of *ServerConfig or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *ServerConfig.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 *ProjectsZonesGetServerconfigCall) Do(opts ...googleapi.CallOption) (*ServerConfig, 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 := &ServerConfig{
+ 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 configuration info about the Container Engine service.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
+ // "httpMethod": "GET",
+ // "id": "container.projects.zones.getServerconfig",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
+ // "response": {
+ // "$ref": "ServerConfig"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.completeIpRotation":
+
+type ProjectsZonesClustersCompleteIpRotationCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ completeiprotationrequest *CompleteIPRotationRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// CompleteIpRotation: Completes master IP rotation.
+func (r *ProjectsZonesClustersService) CompleteIpRotation(projectId string, zone string, clusterId string, completeiprotationrequest *CompleteIPRotationRequest) *ProjectsZonesClustersCompleteIpRotationCall {
+ c := &ProjectsZonesClustersCompleteIpRotationCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.completeiprotationrequest = completeiprotationrequest
+ 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 *ProjectsZonesClustersCompleteIpRotationCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersCompleteIpRotationCall {
+ 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 *ProjectsZonesClustersCompleteIpRotationCall) Context(ctx context.Context) *ProjectsZonesClustersCompleteIpRotationCall {
+ 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 *ProjectsZonesClustersCompleteIpRotationCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersCompleteIpRotationCall) 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.completeiprotationrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.completeIpRotation" 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 *ProjectsZonesClustersCompleteIpRotationCall) 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": "Completes master IP rotation.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.completeIpRotation",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ // "request": {
+ // "$ref": "CompleteIPRotationRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.create":
+
+type ProjectsZonesClustersCreateCall struct {
+ s *Service
+ projectId string
+ zone string
+ createclusterrequest *CreateClusterRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a cluster, consisting of the specified number and
+// type of Google
+// Compute Engine instances.
+//
+// By default, the cluster is created in the project's
+// [default
+// network](/compute/docs/networks-and-firewalls#networks).
+//
+// One firewall is added for the cluster. After cluster creation,
+// the cluster creates routes for each node to allow the containers
+// on that node to communicate with all other instances in
+// the
+// cluster.
+//
+// Finally, an entry is added to the project's global metadata
+// indicating
+// which CIDR range is being used by the cluster.
+func (r *ProjectsZonesClustersService) Create(projectId string, zone string, createclusterrequest *CreateClusterRequest) *ProjectsZonesClustersCreateCall {
+ c := &ProjectsZonesClustersCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.createclusterrequest = createclusterrequest
+ 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 *ProjectsZonesClustersCreateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersCreateCall {
+ 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 *ProjectsZonesClustersCreateCall) Context(ctx context.Context) *ProjectsZonesClustersCreateCall {
+ 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 *ProjectsZonesClustersCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersCreateCall) 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.createclusterrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.create" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *ProjectsZonesClustersCreateCall) 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 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": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.create",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone"
+ // ],
+ // "parameters": {
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ // "request": {
+ // "$ref": "CreateClusterRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.delete":
+
+type ProjectsZonesClustersDeleteCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes the cluster, including the Kubernetes endpoint and
+// all worker
+// nodes.
+//
+// Firewalls and routes that were configured during cluster creation
+// are also deleted.
+//
+// Other Google Compute Engine resources that might be in use by the
+// cluster
+// (e.g. load balancer resources) will not be deleted if they weren't
+// present
+// at the initial create time.
+func (r *ProjectsZonesClustersService) Delete(projectId string, zone string, clusterId string) *ProjectsZonesClustersDeleteCall {
+ c := &ProjectsZonesClustersDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ return c
+}
+
+// Name sets the optional parameter "name": The name (project, location,
+// cluster) of the cluster to delete.
+// Specified in the format 'projects/*/locations/*/clusters/*'.
+func (c *ProjectsZonesClustersDeleteCall) Name(name string) *ProjectsZonesClustersDeleteCall {
+ c.urlParams_.Set("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 *ProjectsZonesClustersDeleteCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersDeleteCall {
+ 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 *ProjectsZonesClustersDeleteCall) Context(ctx context.Context) *ProjectsZonesClustersDeleteCall {
+ 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 *ProjectsZonesClustersDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersDeleteCall) 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, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.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 *ProjectsZonesClustersDeleteCall) 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 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.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ // "httpMethod": "DELETE",
+ // "id": "container.projects.zones.clusters.delete",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.get":
+
+type ProjectsZonesClustersGetCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Gets the details of a specific cluster.
+func (r *ProjectsZonesClustersService) Get(projectId string, zone string, clusterId string) *ProjectsZonesClustersGetCall {
+ c := &ProjectsZonesClustersGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ return c
+}
+
+// Name sets the optional parameter "name": The name (project, location,
+// cluster) of the cluster to retrieve.
+// Specified in the format 'projects/*/locations/*/clusters/*'.
+func (c *ProjectsZonesClustersGetCall) Name(name string) *ProjectsZonesClustersGetCall {
+ c.urlParams_.Set("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 *ProjectsZonesClustersGetCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersGetCall {
+ 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 *ProjectsZonesClustersGetCall) IfNoneMatch(entityTag string) *ProjectsZonesClustersGetCall {
+ 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 *ProjectsZonesClustersGetCall) Context(ctx context.Context) *ProjectsZonesClustersGetCall {
+ 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 *ProjectsZonesClustersGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersGetCall) 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, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.get" call.
+// Exactly one of *Cluster or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Cluster.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 *ProjectsZonesClustersGetCall) Do(opts ...googleapi.CallOption) (*Cluster, 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 := &Cluster{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Gets the details of a specific cluster.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ // "httpMethod": "GET",
+ // "id": "container.projects.zones.clusters.get",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ // "response": {
+ // "$ref": "Cluster"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.legacyAbac":
+
+type ProjectsZonesClustersLegacyAbacCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ setlegacyabacrequest *SetLegacyAbacRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// LegacyAbac: Enables or disables the ABAC authorization mechanism on a
+// cluster.
+func (r *ProjectsZonesClustersService) LegacyAbac(projectId string, zone string, clusterId string, setlegacyabacrequest *SetLegacyAbacRequest) *ProjectsZonesClustersLegacyAbacCall {
+ c := &ProjectsZonesClustersLegacyAbacCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.setlegacyabacrequest = setlegacyabacrequest
+ 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 *ProjectsZonesClustersLegacyAbacCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersLegacyAbacCall {
+ 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 *ProjectsZonesClustersLegacyAbacCall) Context(ctx context.Context) *ProjectsZonesClustersLegacyAbacCall {
+ 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 *ProjectsZonesClustersLegacyAbacCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersLegacyAbacCall) 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.setlegacyabacrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.legacyAbac" 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 *ProjectsZonesClustersLegacyAbacCall) 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": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.legacyAbac",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ // "request": {
+ // "$ref": "SetLegacyAbacRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.list":
+
+type ProjectsZonesClustersListCall struct {
+ s *Service
+ projectId string
+ zone string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists all clusters owned by a project in either the specified
+// zone or all
+// zones.
+func (r *ProjectsZonesClustersService) List(projectId string, zone string) *ProjectsZonesClustersListCall {
+ c := &ProjectsZonesClustersListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ return c
+}
+
+// Parent sets the optional parameter "parent": The parent (project and
+// location) where the clusters will be listed.
+// Specified in the format 'projects/*/locations/*'.
+// Location "-" matches all zones and all regions.
+func (c *ProjectsZonesClustersListCall) Parent(parent string) *ProjectsZonesClustersListCall {
+ c.urlParams_.Set("parent", parent)
+ 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 *ProjectsZonesClustersListCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersListCall {
+ 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 *ProjectsZonesClustersListCall) IfNoneMatch(entityTag string) *ProjectsZonesClustersListCall {
+ 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 *ProjectsZonesClustersListCall) Context(ctx context.Context) *ProjectsZonesClustersListCall {
+ 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 *ProjectsZonesClustersListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersListCall) 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, "v1beta1/projects/{projectId}/zones/{zone}/clusters")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.list" call.
+// Exactly one of *ListClustersResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListClustersResponse.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 *ProjectsZonesClustersListCall) Do(opts ...googleapi.CallOption) (*ListClustersResponse, 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 := &ListClustersResponse{
+ 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 all clusters owned by a project in either the specified zone or all\nzones.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ // "httpMethod": "GET",
+ // "id": "container.projects.zones.clusters.list",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ // "response": {
+ // "$ref": "ListClustersResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.resourceLabels":
+
+type ProjectsZonesClustersResourceLabelsCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ setlabelsrequest *SetLabelsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// ResourceLabels: Sets labels on a cluster.
+func (r *ProjectsZonesClustersService) ResourceLabels(projectId string, zone string, clusterId string, setlabelsrequest *SetLabelsRequest) *ProjectsZonesClustersResourceLabelsCall {
+ c := &ProjectsZonesClustersResourceLabelsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.setlabelsrequest = setlabelsrequest
+ 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 *ProjectsZonesClustersResourceLabelsCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersResourceLabelsCall {
+ 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 *ProjectsZonesClustersResourceLabelsCall) Context(ctx context.Context) *ProjectsZonesClustersResourceLabelsCall {
+ 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 *ProjectsZonesClustersResourceLabelsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersResourceLabelsCall) 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.setlabelsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.resourceLabels" 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 *ProjectsZonesClustersResourceLabelsCall) 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 a cluster.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.resourceLabels",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ // "request": {
+ // "$ref": "SetLabelsRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.setMasterAuth":
+
+type ProjectsZonesClustersSetMasterAuthCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ setmasterauthrequest *SetMasterAuthRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetMasterAuth: Used to set master auth materials. Currently supports
+// :-
+// Changing the admin password of a specific cluster.
+// This can be either via password generation or explicitly set.
+// Modify basic_auth.csv and reset the K8S API server.
+func (r *ProjectsZonesClustersService) SetMasterAuth(projectId string, zone string, clusterId string, setmasterauthrequest *SetMasterAuthRequest) *ProjectsZonesClustersSetMasterAuthCall {
+ c := &ProjectsZonesClustersSetMasterAuthCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.setmasterauthrequest = setmasterauthrequest
+ 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 *ProjectsZonesClustersSetMasterAuthCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersSetMasterAuthCall {
+ 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 *ProjectsZonesClustersSetMasterAuthCall) Context(ctx context.Context) *ProjectsZonesClustersSetMasterAuthCall {
+ 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 *ProjectsZonesClustersSetMasterAuthCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersSetMasterAuthCall) 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.setmasterauthrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.setMasterAuth" 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 *ProjectsZonesClustersSetMasterAuthCall) 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": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.setMasterAuth",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
+ // "request": {
+ // "$ref": "SetMasterAuthRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.setNetworkPolicy":
+
+type ProjectsZonesClustersSetNetworkPolicyCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ setnetworkpolicyrequest *SetNetworkPolicyRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetNetworkPolicy: Enables/Disables Network Policy for a cluster.
+func (r *ProjectsZonesClustersService) SetNetworkPolicy(projectId string, zone string, clusterId string, setnetworkpolicyrequest *SetNetworkPolicyRequest) *ProjectsZonesClustersSetNetworkPolicyCall {
+ c := &ProjectsZonesClustersSetNetworkPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.setnetworkpolicyrequest = setnetworkpolicyrequest
+ 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 *ProjectsZonesClustersSetNetworkPolicyCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersSetNetworkPolicyCall {
+ 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 *ProjectsZonesClustersSetNetworkPolicyCall) Context(ctx context.Context) *ProjectsZonesClustersSetNetworkPolicyCall {
+ 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 *ProjectsZonesClustersSetNetworkPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersSetNetworkPolicyCall) 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.setnetworkpolicyrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.setNetworkPolicy" 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 *ProjectsZonesClustersSetNetworkPolicyCall) 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": "Enables/Disables Network Policy for a cluster.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.setNetworkPolicy",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ // "request": {
+ // "$ref": "SetNetworkPolicyRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.startIpRotation":
+
+type ProjectsZonesClustersStartIpRotationCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ startiprotationrequest *StartIPRotationRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// StartIpRotation: Start master IP rotation.
+func (r *ProjectsZonesClustersService) StartIpRotation(projectId string, zone string, clusterId string, startiprotationrequest *StartIPRotationRequest) *ProjectsZonesClustersStartIpRotationCall {
+ c := &ProjectsZonesClustersStartIpRotationCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.startiprotationrequest = startiprotationrequest
+ 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 *ProjectsZonesClustersStartIpRotationCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersStartIpRotationCall {
+ 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 *ProjectsZonesClustersStartIpRotationCall) Context(ctx context.Context) *ProjectsZonesClustersStartIpRotationCall {
+ 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 *ProjectsZonesClustersStartIpRotationCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersStartIpRotationCall) 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.startiprotationrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.startIpRotation" 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 *ProjectsZonesClustersStartIpRotationCall) 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": "Start master IP rotation.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.startIpRotation",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ // "request": {
+ // "$ref": "StartIPRotationRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.update":
+
+type ProjectsZonesClustersUpdateCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ updateclusterrequest *UpdateClusterRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Update: Updates the settings of a specific cluster.
+func (r *ProjectsZonesClustersService) Update(projectId string, zone string, clusterId string, updateclusterrequest *UpdateClusterRequest) *ProjectsZonesClustersUpdateCall {
+ c := &ProjectsZonesClustersUpdateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.updateclusterrequest = updateclusterrequest
+ 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 *ProjectsZonesClustersUpdateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersUpdateCall {
+ 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 *ProjectsZonesClustersUpdateCall) Context(ctx context.Context) *ProjectsZonesClustersUpdateCall {
+ 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 *ProjectsZonesClustersUpdateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersUpdateCall) 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.updateclusterrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PUT", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.update" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *ProjectsZonesClustersUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Operation{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Updates the settings of a specific cluster.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ // "httpMethod": "PUT",
+ // "id": "container.projects.zones.clusters.update",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ // "request": {
+ // "$ref": "UpdateClusterRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.nodePools.create":
+
+type ProjectsZonesClustersNodePoolsCreateCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ createnodepoolrequest *CreateNodePoolRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a node pool for a cluster.
+func (r *ProjectsZonesClustersNodePoolsService) Create(projectId string, zone string, clusterId string, createnodepoolrequest *CreateNodePoolRequest) *ProjectsZonesClustersNodePoolsCreateCall {
+ c := &ProjectsZonesClustersNodePoolsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.createnodepoolrequest = createnodepoolrequest
+ 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 *ProjectsZonesClustersNodePoolsCreateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersNodePoolsCreateCall {
+ 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 *ProjectsZonesClustersNodePoolsCreateCall) Context(ctx context.Context) *ProjectsZonesClustersNodePoolsCreateCall {
+ 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 *ProjectsZonesClustersNodePoolsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersNodePoolsCreateCall) 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.createnodepoolrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.nodePools.create" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *ProjectsZonesClustersNodePoolsCreateCall) 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 node pool for a cluster.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.nodePools.create",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ // "request": {
+ // "$ref": "CreateNodePoolRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.nodePools.delete":
+
+type ProjectsZonesClustersNodePoolsDeleteCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ nodePoolId string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes a node pool from a cluster.
+func (r *ProjectsZonesClustersNodePoolsService) Delete(projectId string, zone string, clusterId string, nodePoolId string) *ProjectsZonesClustersNodePoolsDeleteCall {
+ c := &ProjectsZonesClustersNodePoolsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.nodePoolId = nodePoolId
+ return c
+}
+
+// Name sets the optional parameter "name": The name (project, location,
+// cluster, node pool id) of the node pool to delete.
+// Specified in the format
+// 'projects/*/locations/*/clusters/*/nodePools/*'.
+func (c *ProjectsZonesClustersNodePoolsDeleteCall) Name(name string) *ProjectsZonesClustersNodePoolsDeleteCall {
+ c.urlParams_.Set("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 *ProjectsZonesClustersNodePoolsDeleteCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersNodePoolsDeleteCall {
+ 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 *ProjectsZonesClustersNodePoolsDeleteCall) Context(ctx context.Context) *ProjectsZonesClustersNodePoolsDeleteCall {
+ 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 *ProjectsZonesClustersNodePoolsDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersNodePoolsDeleteCall) 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, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ "nodePoolId": c.nodePoolId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.nodePools.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 *ProjectsZonesClustersNodePoolsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Operation{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Deletes a node pool from a cluster.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ // "httpMethod": "DELETE",
+ // "id": "container.projects.zones.clusters.nodePools.delete",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId",
+ // "nodePoolId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "nodePoolId": {
+ // "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.nodePools.get":
+
+type ProjectsZonesClustersNodePoolsGetCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ nodePoolId string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Retrieves the node pool requested.
+func (r *ProjectsZonesClustersNodePoolsService) Get(projectId string, zone string, clusterId string, nodePoolId string) *ProjectsZonesClustersNodePoolsGetCall {
+ c := &ProjectsZonesClustersNodePoolsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.nodePoolId = nodePoolId
+ return c
+}
+
+// Name sets the optional parameter "name": The name (project, location,
+// cluster, node pool id) of the node pool to get.
+// Specified in the format
+// 'projects/*/locations/*/clusters/*/nodePools/*'.
+func (c *ProjectsZonesClustersNodePoolsGetCall) Name(name string) *ProjectsZonesClustersNodePoolsGetCall {
+ c.urlParams_.Set("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 *ProjectsZonesClustersNodePoolsGetCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersNodePoolsGetCall {
+ 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 *ProjectsZonesClustersNodePoolsGetCall) IfNoneMatch(entityTag string) *ProjectsZonesClustersNodePoolsGetCall {
+ 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 *ProjectsZonesClustersNodePoolsGetCall) Context(ctx context.Context) *ProjectsZonesClustersNodePoolsGetCall {
+ 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 *ProjectsZonesClustersNodePoolsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersNodePoolsGetCall) 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, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ "nodePoolId": c.nodePoolId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.nodePools.get" call.
+// Exactly one of *NodePool or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *NodePool.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 *ProjectsZonesClustersNodePoolsGetCall) Do(opts ...googleapi.CallOption) (*NodePool, 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 := &NodePool{
+ 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 node pool requested.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ // "httpMethod": "GET",
+ // "id": "container.projects.zones.clusters.nodePools.get",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId",
+ // "nodePoolId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "nodePoolId": {
+ // "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ // "response": {
+ // "$ref": "NodePool"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.nodePools.list":
+
+type ProjectsZonesClustersNodePoolsListCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists the node pools for a cluster.
+func (r *ProjectsZonesClustersNodePoolsService) List(projectId string, zone string, clusterId string) *ProjectsZonesClustersNodePoolsListCall {
+ c := &ProjectsZonesClustersNodePoolsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ return c
+}
+
+// Parent sets the optional parameter "parent": The parent (project,
+// location, cluster id) where the node pools will be listed.
+// Specified in the format 'projects/*/locations/*/clusters/*'.
+func (c *ProjectsZonesClustersNodePoolsListCall) Parent(parent string) *ProjectsZonesClustersNodePoolsListCall {
+ c.urlParams_.Set("parent", parent)
+ 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 *ProjectsZonesClustersNodePoolsListCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersNodePoolsListCall {
+ 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 *ProjectsZonesClustersNodePoolsListCall) IfNoneMatch(entityTag string) *ProjectsZonesClustersNodePoolsListCall {
+ 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 *ProjectsZonesClustersNodePoolsListCall) Context(ctx context.Context) *ProjectsZonesClustersNodePoolsListCall {
+ 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 *ProjectsZonesClustersNodePoolsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersNodePoolsListCall) 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, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.nodePools.list" call.
+// Exactly one of *ListNodePoolsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListNodePoolsResponse.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 *ProjectsZonesClustersNodePoolsListCall) Do(opts ...googleapi.CallOption) (*ListNodePoolsResponse, 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 := &ListNodePoolsResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Lists the node pools for a cluster.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ // "httpMethod": "GET",
+ // "id": "container.projects.zones.clusters.nodePools.list",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ // "response": {
+ // "$ref": "ListNodePoolsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.nodePools.rollback":
+
+type ProjectsZonesClustersNodePoolsRollbackCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ nodePoolId string
+ rollbacknodepoolupgraderequest *RollbackNodePoolUpgradeRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Rollback: Roll back the previously Aborted or Failed NodePool
+// upgrade.
+// This will be an no-op if the last upgrade successfully completed.
+func (r *ProjectsZonesClustersNodePoolsService) Rollback(projectId string, zone string, clusterId string, nodePoolId string, rollbacknodepoolupgraderequest *RollbackNodePoolUpgradeRequest) *ProjectsZonesClustersNodePoolsRollbackCall {
+ c := &ProjectsZonesClustersNodePoolsRollbackCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.nodePoolId = nodePoolId
+ c.rollbacknodepoolupgraderequest = rollbacknodepoolupgraderequest
+ 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 *ProjectsZonesClustersNodePoolsRollbackCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersNodePoolsRollbackCall {
+ 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 *ProjectsZonesClustersNodePoolsRollbackCall) Context(ctx context.Context) *ProjectsZonesClustersNodePoolsRollbackCall {
+ 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 *ProjectsZonesClustersNodePoolsRollbackCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersNodePoolsRollbackCall) 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.rollbacknodepoolupgraderequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ "nodePoolId": c.nodePoolId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.nodePools.rollback" 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 *ProjectsZonesClustersNodePoolsRollbackCall) 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": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.nodePools.rollback",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId",
+ // "nodePoolId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "nodePoolId": {
+ // "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ // "request": {
+ // "$ref": "RollbackNodePoolUpgradeRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.clusters.nodePools.setManagement":
+
+type ProjectsZonesClustersNodePoolsSetManagementCall struct {
+ s *Service
+ projectId string
+ zone string
+ clusterId string
+ nodePoolId string
+ setnodepoolmanagementrequest *SetNodePoolManagementRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetManagement: Sets the NodeManagement options for a node pool.
+func (r *ProjectsZonesClustersNodePoolsService) SetManagement(projectId string, zone string, clusterId string, nodePoolId string, setnodepoolmanagementrequest *SetNodePoolManagementRequest) *ProjectsZonesClustersNodePoolsSetManagementCall {
+ c := &ProjectsZonesClustersNodePoolsSetManagementCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.clusterId = clusterId
+ c.nodePoolId = nodePoolId
+ c.setnodepoolmanagementrequest = setnodepoolmanagementrequest
+ 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 *ProjectsZonesClustersNodePoolsSetManagementCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersNodePoolsSetManagementCall {
+ 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 *ProjectsZonesClustersNodePoolsSetManagementCall) Context(ctx context.Context) *ProjectsZonesClustersNodePoolsSetManagementCall {
+ 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 *ProjectsZonesClustersNodePoolsSetManagementCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesClustersNodePoolsSetManagementCall) 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.setnodepoolmanagementrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "clusterId": c.clusterId,
+ "nodePoolId": c.nodePoolId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.clusters.nodePools.setManagement" 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 *ProjectsZonesClustersNodePoolsSetManagementCall) 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 NodeManagement options for a node pool.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.clusters.nodePools.setManagement",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "clusterId",
+ // "nodePoolId"
+ // ],
+ // "parameters": {
+ // "clusterId": {
+ // "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "nodePoolId": {
+ // "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ // "request": {
+ // "$ref": "SetNodePoolManagementRequest"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.operations.cancel":
+
+type ProjectsZonesOperationsCancelCall struct {
+ s *Service
+ projectId string
+ zone string
+ operationId string
+ canceloperationrequest *CancelOperationRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Cancel: Cancels the specified operation.
+func (r *ProjectsZonesOperationsService) Cancel(projectId string, zone string, operationId string, canceloperationrequest *CancelOperationRequest) *ProjectsZonesOperationsCancelCall {
+ c := &ProjectsZonesOperationsCancelCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.operationId = operationId
+ c.canceloperationrequest = canceloperationrequest
+ 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 *ProjectsZonesOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsZonesOperationsCancelCall {
+ 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 *ProjectsZonesOperationsCancelCall) Context(ctx context.Context) *ProjectsZonesOperationsCancelCall {
+ 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 *ProjectsZonesOperationsCancelCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesOperationsCancelCall) 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.canceloperationrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "operationId": c.operationId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.operations.cancel" call.
+// Exactly one of *Empty or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Empty.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *ProjectsZonesOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Empty{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Cancels the specified operation.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ // "httpMethod": "POST",
+ // "id": "container.projects.zones.operations.cancel",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "operationId"
+ // ],
+ // "parameters": {
+ // "operationId": {
+ // "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ // "request": {
+ // "$ref": "CancelOperationRequest"
+ // },
+ // "response": {
+ // "$ref": "Empty"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.operations.get":
+
+type ProjectsZonesOperationsGetCall struct {
+ s *Service
+ projectId string
+ zone string
+ operationId string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Gets the specified operation.
+func (r *ProjectsZonesOperationsService) Get(projectId string, zone string, operationId string) *ProjectsZonesOperationsGetCall {
+ c := &ProjectsZonesOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ c.operationId = operationId
+ return c
+}
+
+// Name sets the optional parameter "name": The name (project, location,
+// operation id) of the operation to get.
+// Specified in the format 'projects/*/locations/*/operations/*'.
+func (c *ProjectsZonesOperationsGetCall) Name(name string) *ProjectsZonesOperationsGetCall {
+ c.urlParams_.Set("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 *ProjectsZonesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsZonesOperationsGetCall {
+ 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 *ProjectsZonesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsZonesOperationsGetCall {
+ 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 *ProjectsZonesOperationsGetCall) Context(ctx context.Context) *ProjectsZonesOperationsGetCall {
+ 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 *ProjectsZonesOperationsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesOperationsGetCall) 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, "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ "operationId": c.operationId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.operations.get" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *ProjectsZonesOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Operation{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Gets the specified operation.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ // "httpMethod": "GET",
+ // "id": "container.projects.zones.operations.get",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone",
+ // "operationId"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "operationId": {
+ // "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "container.projects.zones.operations.list":
+
+type ProjectsZonesOperationsListCall struct {
+ s *Service
+ projectId string
+ zone string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists all operations in a project in a specific zone or all
+// zones.
+func (r *ProjectsZonesOperationsService) List(projectId string, zone string) *ProjectsZonesOperationsListCall {
+ c := &ProjectsZonesOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.projectId = projectId
+ c.zone = zone
+ return c
+}
+
+// Parent sets the optional parameter "parent": The parent (project and
+// location) where the operations will be listed.
+// Specified in the format 'projects/*/locations/*'.
+// Location "-" matches all zones and all regions.
+func (c *ProjectsZonesOperationsListCall) Parent(parent string) *ProjectsZonesOperationsListCall {
+ c.urlParams_.Set("parent", parent)
+ 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 *ProjectsZonesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsZonesOperationsListCall {
+ 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 *ProjectsZonesOperationsListCall) IfNoneMatch(entityTag string) *ProjectsZonesOperationsListCall {
+ 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 *ProjectsZonesOperationsListCall) Context(ctx context.Context) *ProjectsZonesOperationsListCall {
+ 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 *ProjectsZonesOperationsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsZonesOperationsListCall) 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, "v1beta1/projects/{projectId}/zones/{zone}/operations")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "projectId": c.projectId,
+ "zone": c.zone,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "container.projects.zones.operations.list" call.
+// Exactly one of *ListOperationsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListOperationsResponse.ServerResponse.Header or (if a response was
+// returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *ProjectsZonesOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &ListOperationsResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Lists all operations in a project in a specific zone or all zones.",
+ // "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations",
+ // "httpMethod": "GET",
+ // "id": "container.projects.zones.operations.list",
+ // "parameterOrder": [
+ // "projectId",
+ // "zone"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "zone": {
+ // "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/projects/{projectId}/zones/{zone}/operations",
+ // "response": {
+ // "$ref": "ListOperationsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json
index 0bc5ddc..80bb00f 100644
--- a/dataflow/v1b3/dataflow-api.json
+++ b/dataflow/v1b3/dataflow-api.json
@@ -1,22 +1,12 @@
{
- "batchPath": "batch",
- "documentationLink": "https://cloud.google.com/dataflow",
- "id": "dataflow:v1b3",
- "revision": "20170821",
- "title": "Google Dataflow API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
"resources": {
"projects": {
"methods": {
"workerMessages": {
- "flatPath": "v1b3/projects/{projectId}/WorkerMessages",
- "path": "v1b3/projects/{projectId}/WorkerMessages",
- "id": "dataflow.projects.workerMessages",
- "description": "Send a worker_message to the service.",
"request": {
"$ref": "SendWorkerMessagesRequest"
},
+ "description": "Send a worker_message to the service.",
"httpMethod": "POST",
"parameterOrder": [
"projectId"
@@ -24,41 +14,29 @@
"response": {
"$ref": "SendWorkerMessagesResponse"
},
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project to send the WorkerMessages to.",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
- ]
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project to send the WorkerMessages to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/WorkerMessages",
+ "path": "v1b3/projects/{projectId}/WorkerMessages",
+ "id": "dataflow.projects.workerMessages"
}
},
"resources": {
"locations": {
"methods": {
"workerMessages": {
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
- "id": "dataflow.projects.locations.workerMessages",
- "path": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
- "request": {
- "$ref": "SendWorkerMessagesRequest"
- },
- "description": "Send a worker_message to the service.",
- "response": {
- "$ref": "SendWorkerMessagesResponse"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -78,21 +56,28 @@
"type": "string",
"required": true
}
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
+ "path": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
+ "id": "dataflow.projects.locations.workerMessages",
+ "request": {
+ "$ref": "SendWorkerMessagesRequest"
+ },
+ "description": "Send a worker_message to the service.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "response": {
+ "$ref": "SendWorkerMessagesResponse"
}
}
},
"resources": {
"templates": {
"methods": {
- "launch": {
- "response": {
- "$ref": "LaunchTemplateResponse"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "httpMethod": "POST",
+ "create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -106,32 +91,110 @@
"type": "string",
"required": true
},
- "gcsPath": {
+ "location": {
+ "location": "path",
+ "description": "The location to which to direct the request.",
"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://'."
+ "required": true
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates",
+ "id": "dataflow.projects.locations.templates.create",
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates",
+ "request": {
+ "$ref": "CreateJobFromTemplateRequest"
+ },
+ "description": "Creates a Cloud Dataflow job from a template.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "httpMethod": "POST"
+ },
+ "launch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "validateOnly": {
+ "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "gcsPath": {
+ "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
+ "type": "string",
+ "location": "query"
},
"location": {
+ "description": "The location to which to direct the request.",
"type": "string",
"required": true,
- "location": "path",
- "description": "The location to which to direct the request."
- },
- "validateOnly": {
- "location": "query",
- "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
- "type": "boolean"
+ "location": "path"
}
},
"flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
- "id": "dataflow.projects.locations.templates.launch",
"path": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
+ "id": "dataflow.projects.locations.templates.launch",
"request": {
"$ref": "LaunchTemplateParameters"
},
- "description": "Launch a template."
+ "description": "Launch a template.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "response": {
+ "$ref": "LaunchTemplateResponse"
+ }
},
"get": {
+ "parameters": {
+ "view": {
+ "description": "The view to retrieve. Defaults to METADATA_ONLY.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "METADATA_ONLY"
+ ]
+ },
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "gcsPath": {
+ "location": "query",
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
+ "type": "string"
+ },
+ "location": {
+ "location": "path",
+ "description": "The location to which to direct the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get",
"id": "dataflow.projects.locations.templates.get",
"path": "v1b3/projects/{projectId}/locations/{location}/templates:get",
@@ -143,138 +206,24 @@
"projectId",
"location"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "location": "path",
- "description": "The location to which to direct the request.",
- "type": "string",
- "required": true
- },
- "view": {
- "type": "string",
- "location": "query",
- "enum": [
- "METADATA_ONLY"
- ],
- "description": "The view to retrieve. Defaults to METADATA_ONLY."
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the Cloud Platform project that the job belongs to."
- },
- "gcsPath": {
- "type": "string",
- "location": "query",
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`."
- }
- }
- },
- "create": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The location to which to direct the request."
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates",
- "id": "dataflow.projects.locations.templates.create",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates",
- "request": {
- "$ref": "CreateJobFromTemplateRequest"
- },
- "description": "Creates a Cloud Dataflow job from a template."
+ "httpMethod": "GET"
}
}
},
"jobs": {
"methods": {
- "getMetrics": {
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.locations.jobs.getMetrics",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
- "description": "Request the job status.",
- "response": {
- "$ref": "JobMetrics"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "jobId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The job to get messages for."
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "A project id."
- },
- "location": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The location which contains the job specified by job_id."
- },
- "startTime": {
- "type": "string",
- "location": "query",
- "format": "google-datetime",
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job."
- }
- }
- },
"list": {
+ "id": "dataflow.projects.locations.jobs.list",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "description": "List the jobs of a project in a given region.",
"response": {
"$ref": "ListJobsResponse"
},
+ "httpMethod": "GET",
"parameterOrder": [
"projectId",
"location"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -282,25 +231,18 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
- "location": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The location that contains this job."
- },
"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": {
- "location": "query",
"format": "int32",
"description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"view": {
- "type": "string",
"location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
@@ -308,7 +250,8 @@
"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",
@@ -317,6 +260,7 @@
"required": true
},
"filter": {
+ "description": "The kind of filter to use.",
"type": "string",
"location": "query",
"enum": [
@@ -324,38 +268,29 @@
"ALL",
"TERMINATED",
"ACTIVE"
- ],
- "description": "The kind of filter to use."
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.list",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "description": "List the jobs of a project in a given region."
- },
- "get": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
+ ]
+ },
"location": {
"location": "path",
"description": "The location that contains this job.",
"type": "string",
"required": true
- },
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs"
+ },
+ "get": {
+ "description": "Gets the state of the specified Cloud Dataflow job.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
"view": {
"location": "query",
"enum": [
@@ -368,28 +303,41 @@
"type": "string"
},
"jobId": {
- "location": "path",
"description": "The job ID.",
"type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string",
"required": true
},
- "projectId": {
- "type": "string",
- "required": true,
+ "location": {
"location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to."
+ "description": "The location that contains this job.",
+ "type": "string",
+ "required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "id": "dataflow.projects.locations.jobs.get",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "description": "Gets the state of the specified Cloud Dataflow job."
+ "id": "dataflow.projects.locations.jobs.get"
},
"update": {
+ "id": "dataflow.projects.locations.jobs.update",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "description": "Updates the state of an existing Cloud Dataflow job.",
"request": {
"$ref": "Job"
},
- "description": "Updates the state of an existing Cloud Dataflow job.",
"response": {
"$ref": "Job"
},
@@ -399,41 +347,35 @@
"jobId"
],
"httpMethod": "PUT",
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "The job ID.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "parameters": {
- "location": {
- "location": "path",
- "description": "The location that contains this job.",
- "type": "string",
- "required": true
- },
- "jobId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The job ID."
- },
- "projectId": {
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "id": "dataflow.projects.locations.jobs.update",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"
},
"create": {
- "description": "Creates a Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- },
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -442,6 +384,12 @@
"response": {
"$ref": "Job"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
"location": {
"location": "path",
@@ -466,54 +414,138 @@
"type": "string"
},
"projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
"type": "string",
"required": true,
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to."
+ "location": "path"
}
},
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "id": "dataflow.projects.locations.jobs.create",
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Creates a Cloud Dataflow job."
+ },
+ "getMetrics": {
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.locations.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/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.create"
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string",
+ "required": true
+ },
+ "startTime": {
+ "location": "query",
+ "format": "google-datetime",
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job to get messages for.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "A project id.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics"
}
},
"resources": {
- "workItems": {
+ "messages": {
"methods": {
- "reportStatus": {
+ "list": {
+ "id": "dataflow.projects.locations.jobs.messages.list",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
+ "description": "Request the job status.",
"response": {
- "$ref": "ReportWorkItemStatusResponse"
+ "$ref": "ListJobMessagesResponse"
},
"parameterOrder": [
"projectId",
"location",
"jobId"
],
- "httpMethod": "POST",
+ "httpMethod": "GET",
"parameters": {
- "location": {
- "location": "path",
- "description": "The location which contains the WorkItem's job.",
+ "projectId": {
+ "description": "A project id.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"jobId": {
"location": "path",
- "description": "The job which the WorkItem is part of.",
+ "description": "The job to get messages about.",
"type": "string",
"required": true
},
- "projectId": {
+ "location": {
"location": "path",
- "description": "The project which owns the WorkItem's job.",
+ "description": "The location which contains the job specified by job_id.",
"type": "string",
"required": true
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
+ "type": "string",
+ "location": "query"
+ },
+ "startTime": {
+ "location": "query",
+ "format": "google-datetime",
+ "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "minimumImportance": {
+ "description": "Filter to only get messages with importance \u003e= level",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
+ "JOB_MESSAGE_DEBUG",
+ "JOB_MESSAGE_DETAILED",
+ "JOB_MESSAGE_BASIC",
+ "JOB_MESSAGE_WARNING",
+ "JOB_MESSAGE_ERROR"
+ ]
}
},
"scopes": [
@@ -522,28 +554,13 @@
"https://www.googleapis.com/auth/compute.readonly",
"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",
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- }
- },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages"
+ }
+ }
+ },
+ "workItems": {
+ "methods": {
"lease": {
- "request": {
- "$ref": "LeaseWorkItemRequest"
- },
- "description": "Leases a dataflow WorkItem to run.",
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -552,10 +569,10 @@
],
"parameters": {
"location": {
- "location": "path",
"description": "The location which contains the WorkItem's job.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"jobId": {
"location": "path",
@@ -571,20 +588,55 @@
}
},
"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",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease"
- }
- }
- },
- "debug": {
- "methods": {
- "sendCapture": {
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
- "id": "dataflow.projects.locations.jobs.debug.sendCapture",
- "description": "Send encoded debug capture data for component.",
"request": {
- "$ref": "SendDebugCaptureRequest"
+ "$ref": "LeaseWorkItemRequest"
+ },
+ "description": "Leases a dataflow WorkItem to run.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "LeaseWorkItemResponse"
+ }
+ },
+ "reportStatus": {
+ "parameters": {
+ "jobId": {
+ "description": "The job which the WorkItem is part of.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The project which owns the WorkItem's job.",
+ "type": "string",
+ "required": true
+ },
+ "location": {
+ "location": "path",
+ "description": "The location which contains the WorkItem's job.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
+ "id": "dataflow.projects.locations.jobs.workItems.reportStatus",
+ "description": "Reports the status of dataflow WorkItems leased by a worker.",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
},
"httpMethod": "POST",
"parameterOrder": [
@@ -593,8 +645,20 @@
"jobId"
],
"response": {
- "$ref": "SendDebugCaptureResponse"
- },
+ "$ref": "ReportWorkItemStatusResponse"
+ }
+ }
+ }
+ },
+ "debug": {
+ "methods": {
+ "sendCapture": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
"location": {
"location": "path",
@@ -609,10 +673,48 @@
"required": true
},
"projectId": {
+ "description": "The project id.",
"type": "string",
"required": true,
+ "location": "path"
+ }
+ },
+ "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",
+ "request": {
+ "$ref": "SendDebugCaptureRequest"
+ },
+ "description": "Send encoded debug capture data for component.",
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "POST"
+ },
+ "getConfig": {
+ "parameters": {
+ "jobId": {
+ "description": "The job id.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
"location": "path",
- "description": "The project id."
+ "description": "The project id.",
+ "type": "string",
+ "required": true
+ },
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
@@ -620,132 +722,23 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
- ]
- },
- "getConfig": {
+ ],
"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",
+ "id": "dataflow.projects.locations.jobs.debug.getConfig",
"description": "Get encoded debug configuration for component. Not cacheable.",
"request": {
"$ref": "GetDebugConfigRequest"
},
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
"response": {
"$ref": "GetDebugConfigResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by job_id.",
- "type": "string",
- "required": true
- },
- "jobId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The job id."
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The project id."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- }
- }
- },
- "messages": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListJobMessagesResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "minimumImportance": {
- "location": "query",
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ],
- "description": "Filter to only get messages with importance \u003e= level",
- "type": "string"
- },
- "jobId": {
- "location": "path",
- "description": "The job to get messages about.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "A project id."
- },
- "endTime": {
- "type": "string",
- "location": "query",
- "format": "google-datetime",
- "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available)."
- },
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by job_id.",
- "type": "string",
- "required": true
- },
- "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",
- "format": "google-datetime",
- "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
- "id": "dataflow.projects.locations.jobs.messages.list",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
- "description": "Request the job status."
+ }
}
}
}
@@ -755,6 +748,36 @@
},
"templates": {
"methods": {
+ "create": {
+ "request": {
+ "$ref": "CreateJobFromTemplateRequest"
+ },
+ "description": "Creates a Cloud Dataflow job from 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/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/templates",
+ "id": "dataflow.projects.templates.create",
+ "path": "v1b3/projects/{projectId}/templates"
+ },
"launch": {
"httpMethod": "POST",
"parameterOrder": [
@@ -763,6 +786,12 @@
"response": {
"$ref": "LaunchTemplateResponse"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
"location": {
"location": "query",
@@ -770,37 +799,33 @@
"type": "string"
},
"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",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"type": "string",
- "required": true
+ "required": true,
+ "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://'."
+ "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"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"flatPath": "v1b3/projects/{projectId}/templates:launch",
"path": "v1b3/projects/{projectId}/templates:launch",
"id": "dataflow.projects.templates.launch",
- "description": "Launch a template.",
"request": {
"$ref": "LaunchTemplateParameters"
- }
+ },
+ "description": "Launch a template."
},
"get": {
+ "path": "v1b3/projects/{projectId}/templates:get",
+ "id": "dataflow.projects.templates.get",
"description": "Get the template associated with a template.",
"httpMethod": "GET",
"parameterOrder": [
@@ -809,20 +834,26 @@
"response": {
"$ref": "GetTemplateResponse"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
"view": {
+ "description": "The view to retrieve. Defaults to METADATA_ONLY.",
"type": "string",
"location": "query",
"enum": [
"METADATA_ONLY"
- ],
- "description": "The view to retrieve. Defaults to METADATA_ONLY."
+ ]
},
"projectId": {
- "location": "path",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"gcsPath": {
"location": "query",
@@ -830,139 +861,30 @@
"type": "string"
},
"location": {
- "location": "query",
"description": "The location to which to direct the request.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/templates:get",
- "path": "v1b3/projects/{projectId}/templates:get",
- "id": "dataflow.projects.templates.get"
- },
- "create": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
"type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the Cloud Platform project that the job belongs to."
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/templates",
- "id": "dataflow.projects.templates.create",
- "path": "v1b3/projects/{projectId}/templates",
- "description": "Creates a Cloud Dataflow job from a template.",
- "request": {
- "$ref": "CreateJobFromTemplateRequest"
- }
+ "flatPath": "v1b3/projects/{projectId}/templates:get"
}
}
},
"jobs": {
"methods": {
- "list": {
- "flatPath": "v1b3/projects/{projectId}/jobs",
- "path": "v1b3/projects/{projectId}/jobs",
- "id": "dataflow.projects.jobs.list",
- "description": "List the jobs of a project in a given region.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The project which owns the jobs."
- },
- "filter": {
- "location": "query",
- "enum": [
- "UNKNOWN",
- "ALL",
- "TERMINATED",
- "ACTIVE"
- ],
- "description": "The kind of filter to use.",
- "type": "string"
- },
- "location": {
- "location": "query",
- "description": "The location that contains this job.",
- "type": "string"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit."
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ]
- },
"create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
+ "description": "Creates a Cloud Dataflow job.",
+ "request": {
+ "$ref": "Job"
+ },
"response": {
"$ref": "Job"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
"parameters": {
- "location": {
- "type": "string",
- "location": "query",
- "description": "The location that contains this job."
- },
- "replaceJobId": {
- "type": "string",
- "location": "query",
- "description": "Deprecated. This field is now in the Job message."
- },
"view": {
"location": "query",
"enum": [
@@ -975,10 +897,20 @@
"type": "string"
},
"projectId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to."
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "location": {
+ "location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
+ },
+ "replaceJobId": {
+ "description": "Deprecated. This field is now in the Job message.",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -988,12 +920,8 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"flatPath": "v1b3/projects/{projectId}/jobs",
- "path": "v1b3/projects/{projectId}/jobs",
"id": "dataflow.projects.jobs.create",
- "description": "Creates a Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- }
+ "path": "v1b3/projects/{projectId}/jobs"
},
"getMetrics": {
"description": "Request the job status.",
@@ -1005,17 +933,18 @@
"jobId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
- "location": {
- "location": "query",
- "description": "The location which contains the job specified by job_id.",
- "type": "string"
- },
"startTime": {
- "type": "string",
- "location": "query",
"format": "google-datetime",
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job."
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
+ "type": "string",
+ "location": "query"
},
"jobId": {
"location": "path",
@@ -1024,35 +953,22 @@
"required": true
},
"projectId": {
+ "description": "A project id.",
"type": "string",
"required": true,
- "location": "path",
- "description": "A project id."
+ "location": "path"
+ },
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
"id": "dataflow.projects.jobs.getMetrics",
"path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics"
},
"get": {
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
- "id": "dataflow.projects.jobs.get",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "description": "Gets the state of the specified Cloud Dataflow job.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -1061,11 +977,12 @@
],
"parameters": {
"location": {
- "type": "string",
"location": "query",
- "description": "The location that contains this job."
+ "description": "The location that contains this job.",
+ "type": "string"
},
"view": {
+ "description": "The level of information requested in response.",
"type": "string",
"location": "query",
"enum": [
@@ -1073,8 +990,7 @@
"JOB_VIEW_SUMMARY",
"JOB_VIEW_ALL",
"JOB_VIEW_DESCRIPTION"
- ],
- "description": "The level of information requested in response."
+ ]
},
"jobId": {
"location": "path",
@@ -1083,39 +999,55 @@
"required": true
},
"projectId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to."
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
}
- }
- },
- "update": {
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "id": "dataflow.projects.jobs.get",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "description": "Gets the state of the specified Cloud Dataflow job.",
"response": {
"$ref": "Job"
},
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ]
+ },
+ "update": {
+ "description": "Updates the state of an existing Cloud Dataflow job.",
+ "request": {
+ "$ref": "Job"
+ },
+ "httpMethod": "PUT",
"parameterOrder": [
"projectId",
"jobId"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "Job"
+ },
"parameters": {
"location": {
- "type": "string",
"location": "query",
- "description": "The location that contains this job."
+ "description": "The location that contains this job.",
+ "type": "string"
},
"jobId": {
- "location": "path",
"description": "The job ID.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"projectId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to."
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
@@ -1125,12 +1057,8 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
- "id": "dataflow.projects.jobs.update",
"path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "description": "Updates the state of an existing Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- }
+ "id": "dataflow.projects.jobs.update"
},
"aggregated": {
"httpMethod": "GET",
@@ -1140,29 +1068,17 @@
"response": {
"$ref": "ListJobsResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"parameters": {
- "projectId": {
- "location": "path",
- "description": "The project which owns the jobs.",
- "type": "string",
- "required": true
- },
"filter": {
+ "description": "The kind of filter to use.",
+ "type": "string",
"location": "query",
"enum": [
"UNKNOWN",
"ALL",
"TERMINATED",
"ACTIVE"
- ],
- "description": "The kind of filter to use.",
- "type": "string"
+ ]
},
"location": {
"location": "query",
@@ -1170,18 +1086,17 @@
"type": "string"
},
"pageToken": {
+ "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.",
"type": "string",
- "location": "query",
- "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list."
+ "location": "query"
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"view": {
- "type": "string",
"location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
@@ -1189,34 +1104,134 @@
"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.",
+ "type": "string",
+ "required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"flatPath": "v1b3/projects/{projectId}/jobs:aggregated",
"path": "v1b3/projects/{projectId}/jobs:aggregated",
"id": "dataflow.projects.jobs.aggregated",
"description": "List the jobs of a project across all regions."
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The kind of filter to use.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "UNKNOWN",
+ "ALL",
+ "TERMINATED",
+ "ACTIVE"
+ ]
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "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": {
+ "format": "int32",
+ "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
+ "type": "integer",
+ "location": "query"
+ },
+ "view": {
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ]
+ },
+ "projectId": {
+ "description": "The project which owns the jobs.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs",
+ "id": "dataflow.projects.jobs.list",
+ "path": "v1b3/projects/{projectId}/jobs",
+ "description": "List the jobs of a project in a given region.",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET"
}
},
"resources": {
"workItems": {
"methods": {
- "reportStatus": {
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
- "id": "dataflow.projects.jobs.workItems.reportStatus",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
+ "lease": {
"request": {
- "$ref": "ReportWorkItemStatusRequest"
+ "$ref": "LeaseWorkItemRequest"
},
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
- },
+ "description": "Leases a dataflow WorkItem to run.",
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"jobId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "LeaseWorkItemResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "jobId": {
+ "description": "Identifies the workflow job this worker belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "description": "Identifies the project this worker belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
+ "id": "dataflow.projects.jobs.workItems.lease"
+ },
+ "reportStatus": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -1236,74 +1251,42 @@
"type": "string",
"required": true
}
- }
- },
- "lease": {
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "id": "dataflow.projects.jobs.workItems.lease",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "request": {
- "$ref": "LeaseWorkItemRequest"
},
- "description": "Leases a dataflow WorkItem to run.",
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
+ "id": "dataflow.projects.jobs.workItems.reportStatus",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
+ },
+ "description": "Reports the status of dataflow WorkItems leased by a worker.",
"response": {
- "$ref": "LeaseWorkItemResponse"
+ "$ref": "ReportWorkItemStatusResponse"
},
"parameterOrder": [
"projectId",
"jobId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "jobId": {
- "location": "path",
- "description": "Identifies the workflow job this worker belongs to.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifies the project this worker belongs to."
- }
- }
+ "httpMethod": "POST"
}
}
},
"debug": {
"methods": {
"sendCapture": {
- "request": {
- "$ref": "SendDebugCaptureRequest"
- },
- "description": "Send encoded debug capture data for component.",
- "response": {
- "$ref": "SendDebugCaptureResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"jobId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
"parameters": {
"jobId": {
- "location": "path",
"description": "The job id.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"projectId": {
"location": "path",
@@ -1312,18 +1295,21 @@
"required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
"id": "dataflow.projects.jobs.debug.sendCapture",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture"
+ "description": "Send encoded debug capture data for component.",
+ "request": {
+ "$ref": "SendDebugCaptureRequest"
+ }
},
"getConfig": {
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
- "id": "dataflow.projects.jobs.debug.getConfig",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
- "description": "Get encoded debug configuration for component. Not cacheable.",
- "request": {
- "$ref": "GetDebugConfigRequest"
- },
"response": {
"$ref": "GetDebugConfigResponse"
},
@@ -1334,10 +1320,10 @@
"httpMethod": "POST",
"parameters": {
"jobId": {
+ "description": "The job id.",
"type": "string",
"required": true,
- "location": "path",
- "description": "The job id."
+ "location": "path"
},
"projectId": {
"location": "path",
@@ -1351,13 +1337,23 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
- ]
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
+ "id": "dataflow.projects.jobs.debug.getConfig",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
+ "description": "Get encoded debug configuration for component. Not cacheable.",
+ "request": {
+ "$ref": "GetDebugConfigRequest"
+ }
}
}
},
"messages": {
"methods": {
"list": {
+ "id": "dataflow.projects.jobs.messages.list",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
+ "description": "Request the job status.",
"response": {
"$ref": "ListJobMessagesResponse"
},
@@ -1366,47 +1362,29 @@
"jobId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "A project id."
- },
- "jobId": {
- "location": "path",
- "description": "The job to get messages about.",
- "type": "string",
- "required": true
+ "endTime": {
+ "location": "query",
+ "format": "google-datetime",
+ "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
+ "type": "string"
},
"location": {
+ "description": "The location which contains the job specified by job_id.",
"type": "string",
- "location": "query",
- "description": "The location which contains the job specified by job_id."
- },
- "endTime": {
- "type": "string",
- "location": "query",
- "format": "google-datetime",
- "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available)."
- },
- "startTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
- "type": "string"
+ "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": {
+ "format": "google-datetime",
+ "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
+ "type": "string",
+ "location": "query"
+ },
"pageSize": {
"location": "query",
"format": "int32",
@@ -1414,6 +1392,7 @@
"type": "integer"
},
"minimumImportance": {
+ "description": "Filter to only get messages with importance \u003e= level",
"type": "string",
"location": "query",
"enum": [
@@ -1423,14 +1402,28 @@
"JOB_MESSAGE_BASIC",
"JOB_MESSAGE_WARNING",
"JOB_MESSAGE_ERROR"
- ],
- "description": "Filter to only get messages with importance \u003e= level"
+ ]
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job to get messages about.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "A project id.",
+ "type": "string",
+ "required": true
}
},
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- "id": "dataflow.projects.jobs.messages.list",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- "description": "Request the job status."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages"
}
}
}
@@ -1440,37 +1433,21 @@
}
},
"parameters": {
- "pp": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "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",
@@ -1478,21 +1455,21 @@
"type": "string"
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
]
},
"alt": {
@@ -1512,9 +1489,9 @@
"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"
},
"access_token": {
"location": "query",
@@ -1525,26 +1502,1145 @@
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"schemas": {
- "ShellTask": {
+ "FloatingPointMean": {
+ "id": "FloatingPointMean",
+ "description": "A representation of a floating point mean metric contribution.",
"type": "object",
"properties": {
+ "count": {
+ "$ref": "SplitInt64",
+ "description": "The number of values being aggregated."
+ },
+ "sum": {
+ "format": "double",
+ "description": "The sum of all values being aggregated.",
+ "type": "number"
+ }
+ }
+ },
+ "ReportWorkItemStatusResponse": {
+ "description": "Response from a request to report the status of WorkItems.",
+ "type": "object",
+ "properties": {
+ "workItemServiceStates": {
+ "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
+ "items": {
+ "$ref": "WorkItemServiceState"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ReportWorkItemStatusResponse"
+ },
+ "InstructionOutput": {
+ "description": "An output of an instruction.",
+ "type": "object",
+ "properties": {
+ "onlyCountValueBytes": {
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.",
+ "type": "boolean"
+ },
+ "codec": {
+ "description": "The codec to use to encode data being written via this output.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The user-provided name of this output.",
+ "type": "string"
+ },
+ "originalName": {
+ "description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this.",
+ "type": "string"
+ },
+ "onlyCountKeyBytes": {
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.",
+ "type": "boolean"
+ },
+ "systemName": {
+ "description": "System-defined name of this output.\nUnique across the workflow.",
+ "type": "string"
+ }
+ },
+ "id": "InstructionOutput"
+ },
+ "CreateJobFromTemplateRequest": {
+ "id": "CreateJobFromTemplateRequest",
+ "description": "A request to create a Cloud Dataflow job from a template.",
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The runtime parameters to pass to the job.",
+ "type": "object"
+ },
+ "jobName": {
+ "description": "Required. The job name to use for the created job.",
+ "type": "string"
+ },
+ "gcsPath": {
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
+ "type": "string"
+ },
+ "environment": {
+ "description": "The runtime environment for the job.",
+ "$ref": "RuntimeEnvironment"
+ },
+ "location": {
+ "description": "The location to which to direct the request.",
+ "type": "string"
+ }
+ }
+ },
+ "IntegerMean": {
+ "description": "A representation of an integer mean metric contribution.",
+ "type": "object",
+ "properties": {
+ "sum": {
+ "$ref": "SplitInt64",
+ "description": "The sum of all values being aggregated."
+ },
+ "count": {
+ "description": "The number of values being aggregated.",
+ "$ref": "SplitInt64"
+ }
+ },
+ "id": "IntegerMean"
+ },
+ "ListJobsResponse": {
+ "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest.",
+ "type": "object",
+ "properties": {
+ "jobs": {
+ "description": "A subset of the requested job information.",
+ "items": {
+ "$ref": "Job"
+ },
+ "type": "array"
+ },
+ "failedLocation": {
+ "description": "Zero or more messages describing locations that failed to respond.",
+ "items": {
+ "$ref": "FailedLocation"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Set if there may be more results than fit in this response.",
+ "type": "string"
+ }
+ },
+ "id": "ListJobsResponse"
+ },
+ "ComputationTopology": {
+ "id": "ComputationTopology",
+ "description": "All configuration data for a particular Computation.",
+ "type": "object",
+ "properties": {
+ "outputs": {
+ "description": "The outputs from the computation.",
+ "items": {
+ "$ref": "StreamLocation"
+ },
+ "type": "array"
+ },
+ "stateFamilies": {
+ "description": "The state family values.",
+ "items": {
+ "$ref": "StateFamilyConfig"
+ },
+ "type": "array"
+ },
+ "systemStageName": {
+ "description": "The system stage name.",
+ "type": "string"
+ },
+ "computationId": {
+ "description": "The ID of the computation.",
+ "type": "string"
+ },
+ "inputs": {
+ "description": "The inputs to the computation.",
+ "items": {
+ "$ref": "StreamLocation"
+ },
+ "type": "array"
+ },
+ "keyRanges": {
+ "description": "The key ranges processed by the computation.",
+ "items": {
+ "$ref": "KeyRangeLocation"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "RuntimeEnvironment": {
+ "id": "RuntimeEnvironment",
+ "description": "The environment values to set at runtime.",
+ "type": "object",
+ "properties": {
+ "maxWorkers": {
+ "format": "int32",
+ "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.",
+ "type": "integer"
+ },
+ "serviceAccountEmail": {
+ "description": "The email address of the service account to run the job as.",
+ "type": "string"
+ },
+ "tempLocation": {
+ "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
+ "type": "string"
+ },
+ "bypassTempDirValidation": {
+ "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
+ "type": "boolean"
+ },
+ "machineType": {
+ "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "StreamingSideInputLocation": {
+ "id": "StreamingSideInputLocation",
+ "description": "Identifies the location of a streaming side input.",
+ "type": "object",
+ "properties": {
+ "tag": {
+ "description": "Identifies the particular side input within the streaming Dataflow job.",
+ "type": "string"
+ },
+ "stateFamily": {
+ "description": "Identifies the state family where this side input is stored.",
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "LaunchTemplateResponse": {
+ "description": "Response to the request to launch a template.",
+ "type": "object",
+ "properties": {
+ "job": {
+ "$ref": "Job",
+ "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched."
+ }
+ },
+ "id": "LaunchTemplateResponse"
+ },
+ "DerivedSource": {
+ "id": "DerivedSource",
+ "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.",
+ "type": "object",
+ "properties": {
+ "derivationMode": {
+ "enumDescriptions": [
+ "The source derivation is unknown, or unspecified.",
+ "Produce a completely independent Source with no base.",
+ "Produce a Source based on the Source being split.",
+ "Produce a Source based on the base of the Source being split."
+ ],
+ "enum": [
+ "SOURCE_DERIVATION_MODE_UNKNOWN",
+ "SOURCE_DERIVATION_MODE_INDEPENDENT",
+ "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
+ "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
+ ],
+ "description": "What source to base the produced source on (if any).",
+ "type": "string"
+ },
+ "source": {
+ "description": "Specification of the source.",
+ "$ref": "Source"
+ }
+ }
+ },
+ "DynamicSourceSplit": {
+ "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",
+ "properties": {
+ "residual": {
+ "$ref": "DerivedSource",
+ "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source."
+ },
+ "primary": {
+ "$ref": "DerivedSource",
+ "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current."
+ }
+ }
+ },
+ "Job": {
+ "description": "Defines a job to be run by the Cloud Dataflow service.",
+ "type": "object",
+ "properties": {
+ "pipelineDescription": {
+ "$ref": "PipelineDescription",
+ "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL."
+ },
+ "replaceJobId": {
+ "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job.",
+ "type": "string"
+ },
+ "requestedState": {
+ "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'."
+ ],
+ "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"
+ ]
+ },
+ "tempFiles": {
+ "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "clientRequestId": {
+ "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`",
+ "type": "string"
+ },
+ "steps": {
+ "description": "The top-level steps that constitute the entire job.",
+ "items": {
+ "$ref": "Step"
+ },
+ "type": "array"
+ },
+ "replacedByJobId": {
+ "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.",
+ "type": "string"
+ },
+ "executionInfo": {
+ "$ref": "JobExecutionInfo",
+ "description": "Deprecated."
+ },
+ "currentState": {
+ "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"
+ },
+ "currentStateTime": {
+ "format": "google-datetime",
+ "description": "The timestamp associated with the current state.",
+ "type": "string"
+ },
+ "transformNameMapping": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
+ "type": "object"
+ },
+ "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": {
+ "format": "google-datetime",
+ "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
+ "type": "string"
+ },
+ "stageStates": {
+ "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
+ "items": {
+ "$ref": "ExecutionStageState"
+ },
+ "type": "array"
+ },
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of Cloud Dataflow job.",
+ "type": "string",
+ "enumDescriptions": [
+ "The type of the job is unspecified, or unknown.",
+ "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.",
+ "A continuously streaming job with no end: data is read,\nprocessed, and written continuously."
+ ],
+ "enum": [
+ "JOB_TYPE_UNKNOWN",
+ "JOB_TYPE_BATCH",
+ "JOB_TYPE_STREAMING"
+ ]
+ }
+ },
+ "id": "Job"
+ },
+ "SourceOperationResponse": {
+ "id": "SourceOperationResponse",
+ "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
+ "type": "object",
+ "properties": {
+ "getMetadata": {
+ "$ref": "SourceGetMetadataResponse",
+ "description": "A response to a request to get metadata about a source."
+ },
+ "split": {
+ "$ref": "SourceSplitResponse",
+ "description": "A response to a request to split a source."
+ }
+ }
+ },
+ "SideInputInfo": {
+ "id": "SideInputInfo",
+ "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
+ "type": "object",
+ "properties": {
+ "tag": {
+ "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo.",
+ "type": "string"
+ },
+ "kind": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "How to interpret the source element(s) as a side input value.",
+ "type": "object"
+ },
+ "sources": {
+ "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required.",
+ "items": {
+ "$ref": "Source"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "SendDebugCaptureResponse": {
+ "id": "SendDebugCaptureResponse",
+ "description": "Response to a send capture request.\nnothing",
+ "type": "object",
+ "properties": {}
+ },
+ "WriteInstruction": {
+ "id": "WriteInstruction",
+ "description": "An instruction that writes records.\nTakes one input, produces no outputs.",
+ "type": "object",
+ "properties": {
+ "sink": {
+ "description": "The sink to write to.",
+ "$ref": "Sink"
+ },
+ "input": {
+ "$ref": "InstructionInput",
+ "description": "The input."
+ }
+ }
+ },
+ "ConcatPosition": {
+ "description": "A position that encapsulates an inner position and an index for the inner\nposition. A ConcatPosition can be used by a reader of a source that\nencapsulates a set of other sources.",
+ "type": "object",
+ "properties": {
+ "position": {
+ "$ref": "Position",
+ "description": "Position within the inner source."
+ },
+ "index": {
+ "format": "int32",
+ "description": "Index of the inner source.",
+ "type": "integer"
+ }
+ },
+ "id": "ConcatPosition"
+ },
+ "CounterStructuredNameAndMetadata": {
+ "id": "CounterStructuredNameAndMetadata",
+ "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "$ref": "CounterStructuredName",
+ "description": "Structured name of the counter."
+ },
+ "metadata": {
+ "$ref": "CounterMetadata",
+ "description": "Metadata associated with a counter"
+ }
+ }
+ },
+ "AutoscalingSettings": {
+ "description": "Settings for WorkerPool autoscaling.",
+ "type": "object",
+ "properties": {
+ "maxNumWorkers": {
+ "format": "int32",
+ "description": "The maximum number of workers to cap scaling at.",
+ "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"
+ },
+ "StreamingComputationRanges": {
+ "id": "StreamingComputationRanges",
+ "description": "Describes full or partial data disk assignment information of the computation\nranges.",
+ "type": "object",
+ "properties": {
+ "computationId": {
+ "description": "The ID of the computation.",
+ "type": "string"
+ },
+ "rangeAssignments": {
+ "description": "Data disk assignments for ranges from this computation.",
+ "items": {
+ "$ref": "KeyRangeDataDiskAssignment"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "ExecutionStageSummary": {
+ "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.",
+ "type": "object",
+ "properties": {
+ "outputSource": {
+ "description": "Output sources for this stage.",
+ "items": {
+ "$ref": "StageSource"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Dataflow service generated name for this stage.",
+ "type": "string"
+ },
+ "inputSource": {
+ "description": "Input sources for this stage.",
+ "items": {
+ "$ref": "StageSource"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Dataflow service generated id for this stage.",
+ "type": "string"
+ },
+ "componentTransform": {
+ "description": "Transforms that comprise this execution stage.",
+ "items": {
+ "$ref": "ComponentTransform"
+ },
+ "type": "array"
+ },
+ "componentSource": {
+ "description": "Collections produced and consumed by component transforms of this stage.",
+ "items": {
+ "$ref": "ComponentSource"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "Type of tranform this stage is executing.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unrecognized transform type.",
+ "ParDo transform.",
+ "Group By Key transform.",
+ "Flatten transform.",
+ "Read transform.",
+ "Write transform.",
+ "Constructs from a constant value, such as with Create.of.",
+ "Creates a Singleton view of a collection.",
+ "Opening or closing a shuffle session, often as part of a GroupByKey."
+ ],
+ "enum": [
+ "UNKNOWN_KIND",
+ "PAR_DO_KIND",
+ "GROUP_BY_KEY_KIND",
+ "FLATTEN_KIND",
+ "READ_KIND",
+ "WRITE_KIND",
+ "CONSTANT_KIND",
+ "SINGLETON_KIND",
+ "SHUFFLE_KIND"
+ ]
+ }
+ }
+ },
+ "LogBucket": {
+ "description": "Bucket of values for Distribution's logarithmic histogram.",
+ "type": "object",
+ "properties": {
+ "log": {
+ "format": "int32",
+ "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",
+ "type": "integer"
+ },
+ "count": {
+ "format": "int64",
+ "description": "Number of values in this bucket.",
+ "type": "string"
+ }
+ },
+ "id": "LogBucket"
+ },
+ "SendWorkerMessagesRequest": {
+ "description": "A request for sending worker messages to the service.",
+ "type": "object",
+ "properties": {
+ "workerMessages": {
+ "description": "The WorkerMessages to send.",
+ "items": {
+ "$ref": "WorkerMessage"
+ },
+ "type": "array"
+ },
+ "location": {
+ "description": "The location which contains the job",
+ "type": "string"
+ }
+ },
+ "id": "SendWorkerMessagesRequest"
+ },
+ "SourceSplitShard": {
+ "description": "DEPRECATED in favor of DerivedSource.",
+ "type": "object",
+ "properties": {
+ "derivationMode": {
+ "description": "DEPRECATED",
+ "type": "string",
+ "enumDescriptions": [
+ "The source derivation is unknown, or unspecified.",
+ "Produce a completely independent Source with no base.",
+ "Produce a Source based on the Source being split.",
+ "Produce a Source based on the base of the Source being split."
+ ],
+ "enum": [
+ "SOURCE_DERIVATION_MODE_UNKNOWN",
+ "SOURCE_DERIVATION_MODE_INDEPENDENT",
+ "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
+ "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
+ ]
+ },
+ "source": {
+ "description": "DEPRECATED",
+ "$ref": "Source"
+ }
+ },
+ "id": "SourceSplitShard"
+ },
+ "CPUTime": {
+ "id": "CPUTime",
+ "description": "Modeled after information exposed by /proc/stat.",
+ "type": "object",
+ "properties": {
+ "rate": {
+ "format": "double",
+ "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
+ "type": "number"
+ },
+ "timestamp": {
+ "format": "google-datetime",
+ "description": "Timestamp of the measurement.",
+ "type": "string"
+ },
+ "totalMs": {
+ "format": "uint64",
+ "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
+ "type": "string"
+ }
+ }
+ },
+ "Environment": {
+ "description": "Describes the environment in which a Dataflow Job runs.",
+ "type": "object",
+ "properties": {
+ "workerPools": {
+ "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.",
+ "items": {
+ "$ref": "WorkerPool"
+ },
+ "type": "array"
+ },
+ "dataset": {
+ "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}",
+ "type": "string"
+ },
+ "experiments": {
+ "description": "The list of experiments to enable.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "version": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
+ "type": "object"
+ },
+ "internalExperiments": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Experimental settings.",
+ "type": "object"
+ },
+ "serviceAccountEmail": {
+ "description": "Identity to run virtual machines as. Defaults to the default account.",
+ "type": "string"
+ },
+ "sdkPipelineOptions": {
+ "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",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "userAgent": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "A description of the process that generated the request.",
+ "type": "object"
+ },
+ "clusterManagerApiService": {
+ "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\".",
+ "type": "string"
+ },
+ "tempStoragePrefix": {
+ "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
+ }
+ },
+ "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": {
+ "description": "A type of streaming computation task.",
+ "type": "string",
+ "enumDescriptions": [
+ "The streaming computation task is unknown, or unspecified.",
+ "Stop processing specified streaming computation range(s).",
+ "Start processing specified streaming computation range(s)."
+ ],
+ "enum": [
+ "STREAMING_COMPUTATION_TASK_UNKNOWN",
+ "STREAMING_COMPUTATION_TASK_STOP",
+ "STREAMING_COMPUTATION_TASK_START"
+ ]
+ },
+ "computationRanges": {
+ "description": "Contains ranges of a streaming computation this task should apply to.",
+ "items": {
+ "$ref": "StreamingComputationRanges"
+ },
+ "type": "array"
+ },
+ "dataDisks": {
+ "description": "Describes the set of data disks this task should apply to.",
+ "items": {
+ "$ref": "MountedDataDisk"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "SendDebugCaptureRequest": {
+ "description": "Request to send encoded debug information.",
+ "type": "object",
+ "properties": {
+ "componentId": {
+ "description": "The internal component id for which debug information is sent.",
+ "type": "string"
+ },
+ "workerId": {
+ "description": "The worker id, i.e., VM hostname.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string"
+ },
+ "data": {
+ "description": "The encoded debug information.",
+ "type": "string"
+ }
+ },
+ "id": "SendDebugCaptureRequest"
+ },
+ "GetDebugConfigResponse": {
+ "id": "GetDebugConfigResponse",
+ "description": "Response to a get debug configuration request.",
+ "type": "object",
+ "properties": {
+ "config": {
+ "description": "The encoded debug configuration for the requested component.",
+ "type": "string"
+ }
+ }
+ },
+ "ComponentTransform": {
+ "description": "Description of a transform executed as part of an execution stage.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Dataflow service generated name for this source.",
+ "type": "string"
+ },
+ "userName": {
+ "description": "Human-readable name for this transform; may be user or system generated.",
+ "type": "string"
+ },
+ "originalTransform": {
+ "description": "User name for the original user transform with which this transform is\nmost closely associated.",
+ "type": "string"
+ }
+ },
+ "id": "ComponentTransform"
+ },
+ "StreamingSetupTask": {
+ "description": "A task which initializes part of a streaming Dataflow job.",
+ "type": "object",
+ "properties": {
+ "streamingComputationTopology": {
+ "description": "The global topology of the streaming Dataflow job.",
+ "$ref": "TopologyConfig"
+ },
+ "drain": {
+ "description": "The user has requested drain.",
+ "type": "boolean"
+ },
+ "workerHarnessPort": {
+ "format": "int32",
+ "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
+ "type": "integer"
+ },
+ "receiveWorkPort": {
+ "format": "int32",
+ "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.",
+ "type": "integer"
+ }
+ },
+ "id": "StreamingSetupTask"
+ },
+ "PubsubLocation": {
+ "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
+ "type": "object",
+ "properties": {
+ "withAttributes": {
+ "description": "If true, then the client has requested to get pubsub attributes.",
+ "type": "boolean"
+ },
+ "idLabel": {
+ "description": "If set, contains a pubsub label from which to extract record ids.\nIf left empty, record deduplication will be strictly best effort.",
+ "type": "string"
+ },
+ "timestampLabel": {
+ "description": "If set, contains a pubsub label from which to extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.",
+ "type": "string"
+ },
+ "topic": {
+ "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/\u003cproject-id\u003e/\u003ctopic-name\u003e\"",
+ "type": "string"
+ },
+ "subscription": {
+ "description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/\u003cproject-id\u003e/\u003csubscription-name\u003e\"",
+ "type": "string"
+ },
+ "dropLateData": {
+ "description": "Indicates whether the pipeline allows late-arriving data.",
+ "type": "boolean"
+ },
+ "trackingSubscription": {
+ "description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation.",
+ "type": "string"
+ }
+ },
+ "id": "PubsubLocation"
+ },
+ "WorkerHealthReport": {
+ "description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.",
+ "type": "object",
+ "properties": {
+ "pods": {
+ "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ },
+ "vmStartupTime": {
+ "format": "google-datetime",
+ "description": "The time the VM was booted.",
+ "type": "string"
+ },
+ "reportInterval": {
+ "format": "google-duration",
+ "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
+ "type": "string"
+ },
+ "vmIsHealthy": {
+ "description": "Whether the VM is healthy.",
+ "type": "boolean"
+ }
+ },
+ "id": "WorkerHealthReport"
+ },
+ "JobMessage": {
+ "description": "A particular message pertaining to a Dataflow job.",
+ "type": "object",
+ "properties": {
+ "time": {
+ "format": "google-datetime",
+ "description": "The timestamp of the message.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Deprecated.",
+ "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",
+ "JOB_MESSAGE_DETAILED",
+ "JOB_MESSAGE_BASIC",
+ "JOB_MESSAGE_WARNING",
+ "JOB_MESSAGE_ERROR"
+ ],
+ "description": "Importance level of the message.",
+ "type": "string"
+ },
+ "messageText": {
+ "description": "The text of the message.",
+ "type": "string"
+ }
+ },
+ "id": "JobMessage"
+ },
+ "ParameterMetadata": {
+ "description": "Metadata for a specific parameter.",
+ "type": "object",
+ "properties": {
+ "label": {
+ "description": "Required. The label to display for the parameter.",
+ "type": "string"
+ },
+ "helpText": {
+ "description": "Required. The help text to display for the parameter.",
+ "type": "string"
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ParameterMetadata"
+ },
+ "MultiOutputInfo": {
+ "id": "MultiOutputInfo",
+ "description": "Information about an output of a multi-output DoFn.",
+ "type": "object",
+ "properties": {
+ "tag": {
+ "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.",
+ "type": "string"
+ }
+ }
+ },
+ "SourceSplitRequest": {
+ "description": "Represents the operation to split a high-level Source specification\ninto bundles (parts for parallel processing).\n\nAt a high level, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
+ "type": "object",
+ "properties": {
+ "options": {
+ "description": "Hints for tuning the splitting process.",
+ "$ref": "SourceSplitOptions"
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "Specification of the source to be split."
+ }
+ },
+ "id": "SourceSplitRequest"
+ },
+ "SourceGetMetadataResponse": {
+ "description": "The result of a SourceGetMetadataOperation.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "The computed metadata.",
+ "$ref": "SourceMetadata"
+ }
+ },
+ "id": "SourceGetMetadataResponse"
+ },
+ "ShellTask": {
+ "id": "ShellTask",
+ "description": "A task which consists of a shell command for the worker to execute.",
+ "type": "object",
+ "properties": {
+ "command": {
+ "description": "The shell command to run.",
+ "type": "string"
+ },
"exitCode": {
"format": "int32",
"description": "Exit code for the task.",
"type": "integer"
- },
- "command": {
- "type": "string",
- "description": "The shell command to run."
}
- },
- "id": "ShellTask",
- "description": "A task which consists of a shell command for the worker to execute."
+ }
},
"MetricShortId": {
+ "id": "MetricShortId",
+ "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest",
"type": "object",
"properties": {
"metricIndex": {
@@ -1553,33 +2649,18 @@
"type": "integer"
},
"shortId": {
- "type": "string",
"format": "int64",
- "description": "The service-generated short identifier for the metric."
+ "description": "The service-generated short identifier for the metric.",
+ "type": "string"
}
- },
- "id": "MetricShortId",
- "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest"
+ }
},
"AutoscalingEvent": {
+ "id": "AutoscalingEvent",
+ "description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice.",
"type": "object",
"properties": {
- "currentNumWorkers": {
- "format": "int64",
- "description": "The current number of workers the job has.",
- "type": "string"
- },
- "time": {
- "format": "google-datetime",
- "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
- "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."
- },
"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.",
@@ -1594,23 +2675,54 @@
"ACTUATION_FAILURE",
"NO_CHANGE"
],
- "description": "The type of autoscaling event to report."
+ "description": "The type of autoscaling event to report.",
+ "type": "string"
},
"targetNumWorkers": {
- "type": "string",
"format": "int64",
- "description": "The target number of workers the worker pool wants to resize to use."
+ "description": "The target number of workers the worker pool wants to resize to use.",
+ "type": "string"
+ },
+ "currentNumWorkers": {
+ "format": "int64",
+ "description": "The current number of workers the job has.",
+ "type": "string"
+ },
+ "time": {
+ "format": "google-datetime",
+ "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decided to\nnot make any changes to the number of workers.",
+ "$ref": "StructuredMessage"
}
- },
- "id": "AutoscalingEvent",
- "description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice."
+ }
},
"TaskRunnerSettings": {
+ "id": "TaskRunnerSettings",
+ "description": "Taskrunner configuration settings.",
"type": "object",
"properties": {
+ "continueOnException": {
+ "description": "Whether to continue taskrunner if an exception is hit.",
+ "type": "boolean"
+ },
+ "parallelWorkerSettings": {
+ "$ref": "WorkerSettings",
+ "description": "The settings to pass to the parallel worker harness."
+ },
+ "taskUser": {
+ "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
+ "type": "string"
+ },
+ "vmId": {
+ "description": "The ID string of the VM.",
+ "type": "string"
+ },
"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\".",
@@ -1624,124 +2736,124 @@
"description": "The directory on the VM to store logs.",
"type": "string"
},
+ "dataflowApiVersion": {
+ "description": "The API version of endpoint, e.g. \"v1b3\"",
+ "type": "string"
+ },
"oauthScopes": {
+ "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API."
+ "type": "array"
},
- "dataflowApiVersion": {
- "description": "The API version of endpoint, e.g. \"v1b3\"",
+ "streamingWorkerMainClass": {
+ "description": "The streaming worker main class name.",
"type": "string"
},
"logUploadLocation": {
"description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
"type": "string"
},
- "streamingWorkerMainClass": {
- "description": "The streaming worker main class name.",
- "type": "string"
- },
"workflowFileName": {
"description": "The file to store the workflow in.",
"type": "string"
},
- "languageHint": {
- "description": "The suggested backend language.",
- "type": "string"
- },
- "commandlinesFileName": {
- "type": "string",
- "description": "The file to store preprocessing commands in."
- },
- "tempStoragePrefix": {
- "description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
- },
"baseTaskDir": {
"description": "The location on the worker for task-specific subdirectories.",
"type": "string"
},
+ "tempStoragePrefix": {
+ "description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
+ },
+ "commandlinesFileName": {
+ "description": "The file to store preprocessing commands in.",
+ "type": "string"
+ },
+ "languageHint": {
+ "description": "The suggested backend language.",
+ "type": "string"
+ },
"baseUrl": {
- "type": "string",
- "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\""
+ "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
+ "type": "string"
},
"logToSerialconsole": {
- "type": "boolean",
- "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole."
- },
- "continueOnException": {
- "description": "Whether to continue taskrunner if an exception is hit.",
+ "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole.",
"type": "boolean"
- },
- "parallelWorkerSettings": {
- "$ref": "WorkerSettings",
- "description": "The settings to pass to the parallel worker harness."
- },
- "taskUser": {
- "type": "string",
- "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\"."
- },
- "vmId": {
- "description": "The ID string of the VM.",
- "type": "string"
}
- },
- "id": "TaskRunnerSettings",
- "description": "Taskrunner configuration settings."
+ }
},
"Position": {
+ "id": "Position",
"description": "Position defines a position within a collection of data. The value\ncan be either the end position, a key (used with ordered\ncollections), a byte offset, or a record index.",
"type": "object",
"properties": {
- "recordIndex": {
- "type": "string",
- "format": "int64",
- "description": "Position is a record index."
- },
- "shufflePosition": {
- "type": "string",
- "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding)."
- },
"concatPosition": {
- "$ref": "ConcatPosition",
- "description": "CloudPosition is a concat position."
+ "description": "CloudPosition is a concat position.",
+ "$ref": "ConcatPosition"
},
"byteOffset": {
- "type": "string",
"format": "int64",
- "description": "Position is a byte offset."
+ "description": "Position is a byte offset.",
+ "type": "string"
},
"end": {
"description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range.",
"type": "boolean"
},
"key": {
- "type": "string",
- "description": "Position is a string key, ordered lexicographically."
+ "description": "Position is a string key, ordered lexicographically.",
+ "type": "string"
+ },
+ "recordIndex": {
+ "format": "int64",
+ "description": "Position is a record index.",
+ "type": "string"
+ },
+ "shufflePosition": {
+ "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).",
+ "type": "string"
+ }
+ }
+ },
+ "SplitInt64": {
+ "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.",
+ "type": "object",
+ "properties": {
+ "lowBits": {
+ "format": "uint32",
+ "description": "The low order bits: n & 0xffffffff.",
+ "type": "integer"
+ },
+ "highBits": {
+ "format": "int32",
+ "description": "The high order bits, including the sign: n \u003e\u003e 32.",
+ "type": "integer"
}
},
- "id": "Position"
+ "id": "SplitInt64"
},
"Source": {
+ "id": "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).",
"items": {
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
+ "description": "Properties of the object.",
+ "type": "any"
},
"type": "object"
},
- "type": "array",
- "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs)."
+ "type": "array"
},
"doesNotNeedSplitting": {
"description": "Setting this value to true hints to the framework that the source\ndoesn't need splitting, and using SourceSplitRequest on it would\nyield SOURCE_SPLIT_OUTCOME_USE_CURRENT.\n\nE.g. a file splitter may set this to true when splitting a single file\ninto a set of byte ranges of appropriate size, and set this\nto false when splitting a filepattern into individual files.\nHowever, for efficiency, a file splitter may decide to produce\nfile subranges directly from the filepattern to avoid a splitting\nround-trip.\n\nSee SourceSplitRequest for an overview of the splitting process.\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated.",
@@ -1756,63 +2868,99 @@
"type": "object"
},
"spec": {
+ "description": "The source to read from, plus its parameters.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- },
- "description": "The source to read from, plus its parameters.",
- "type": "object"
+ }
}
- },
- "id": "Source"
- },
- "SplitInt64": {
- "type": "object",
- "properties": {
- "lowBits": {
- "type": "integer",
- "format": "uint32",
- "description": "The low order bits: n & 0xffffffff."
- },
- "highBits": {
- "format": "int32",
- "description": "The high order bits, including the sign: n \u003e\u003e 32.",
- "type": "integer"
- }
- },
- "id": "SplitInt64",
- "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON."
+ }
},
"WorkerPool": {
"description": "Describes one particular pool of Cloud Dataflow workers to be\ninstantiated by the Cloud Dataflow service in order to perform the\ncomputations required by a job. Note that a workflow job may use\nmultiple pools, in order to match the various computational\nrequirements of the various stages of the job.",
"type": "object",
"properties": {
+ "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"
+ ]
+ },
+ "autoscalingSettings": {
+ "$ref": "AutoscalingSettings",
+ "description": "Settings for autoscaling of this WorkerPool."
+ },
+ "taskrunnerSettings": {
+ "description": "Settings passed through to Google Compute Engine workers when\nusing the standard Dataflow task runner. Users should ignore\nthis field.",
+ "$ref": "TaskRunnerSettings"
+ },
+ "metadata": {
+ "description": "Metadata to set on the Google Compute Engine VMs.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "network": {
+ "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".",
+ "type": "string"
+ },
+ "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"
+ ]
+ },
"numThreadsPerWorker": {
"format": "int32",
"description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according to the number of cores\non the selected machine type for batch, or 1 by convention for streaming).",
"type": "integer"
},
"numWorkers": {
- "type": "integer",
"format": "int32",
- "description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default."
+ "description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
+ "type": "integer"
},
"zone": {
"description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.",
"type": "string"
},
"diskSourceImage": {
- "type": "string",
- "description": "Fully qualified source image for disks."
+ "description": "Fully qualified source image for disks.",
+ "type": "string"
},
"packages": {
+ "description": "Packages to be installed on workers.",
"items": {
"$ref": "Package"
},
- "type": "array",
- "description": "Packages to be installed on workers."
+ "type": "array"
},
"teardownPolicy": {
+ "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault.",
"type": "string",
"enumDescriptions": [
"The teardown policy isn't specified, or is unknown.",
@@ -1825,41 +2973,40 @@
"TEARDOWN_ALWAYS",
"TEARDOWN_ON_SUCCESS",
"TEARDOWN_NEVER"
- ],
- "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault."
+ ]
},
"onHostMaintenance": {
- "type": "string",
- "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API."
+ "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.",
+ "type": "string"
},
"poolArgs": {
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
"description": "Extra arguments for this worker pool.",
"type": "object"
},
"diskSizeGb": {
- "type": "integer",
"format": "int32",
- "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default."
+ "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
+ "type": "integer"
},
"workerHarnessContainerImage": {
"description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
"type": "string"
},
- "diskType": {
- "type": "string",
- "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default."
- },
"machineType": {
- "type": "string",
- "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default."
+ "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
+ "type": "string"
+ },
+ "diskType": {
+ "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default.",
+ "type": "string"
},
"kind": {
- "type": "string",
- "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported."
+ "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.",
@@ -1867,92 +3014,52 @@
"$ref": "Disk"
},
"type": "array"
- },
- "subnetwork": {
- "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\".",
- "type": "string"
- },
- "ipConfiguration": {
- "enum": [
- "WORKER_IP_UNSPECIFIED",
- "WORKER_IP_PUBLIC",
- "WORKER_IP_PRIVATE"
- ],
- "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."
- ]
- },
- "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": {
- "enum": [
- "DEFAULT_PACKAGE_SET_UNKNOWN",
- "DEFAULT_PACKAGE_SET_NONE",
- "DEFAULT_PACKAGE_SET_JAVA",
- "DEFAULT_PACKAGE_SET_PYTHON"
- ],
- "description": "The default package set to install. This allows the service to\nselect a default set of packages which are useful to worker\nharnesses written in a particular language.",
- "type": "string",
- "enumDescriptions": [
- "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."
- ]
}
},
"id": "WorkerPool"
},
"SourceOperationRequest": {
+ "id": "SourceOperationRequest",
+ "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
"type": "object",
"properties": {
+ "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."
- },
- "getMetadata": {
- "$ref": "SourceGetMetadataRequest",
- "description": "Information about a request to get metadata about a source."
}
- },
- "id": "SourceOperationRequest",
- "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification."
+ }
},
- "WorkItem": {
+ "StructuredMessage": {
+ "id": "StructuredMessage",
+ "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption.",
"type": "object",
"properties": {
- "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.",
+ "parameters": {
+ "description": "The structured data associated with this message.",
"items": {
- "$ref": "Package"
+ "$ref": "Parameter"
},
"type": "array"
},
+ "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"
+ }
+ }
+ },
+ "WorkItem": {
+ "id": "WorkItem",
+ "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.",
+ "type": "object",
+ "properties": {
"projectId": {
"description": "Identifies the cloud project this WorkItem belongs to.",
"type": "string"
@@ -1961,24 +3068,24 @@
"$ref": "SourceOperationRequest",
"description": "Additional information for source operation WorkItems."
},
+ "streamingSetupTask": {
+ "description": "Additional information for StreamingSetupTask WorkItems.",
+ "$ref": "StreamingSetupTask"
+ },
"reportStatusInterval": {
"format": "google-duration",
"description": "Recommended reporting interval.",
"type": "string"
},
- "streamingSetupTask": {
- "$ref": "StreamingSetupTask",
- "description": "Additional information for StreamingSetupTask WorkItems."
+ "streamingConfigTask": {
+ "$ref": "StreamingConfigTask",
+ "description": "Additional information for StreamingConfigTask WorkItems."
},
"leaseExpireTime": {
"format": "google-datetime",
"description": "Time when the lease on this Work will expire.",
"type": "string"
},
- "streamingConfigTask": {
- "$ref": "StreamingConfigTask",
- "description": "Additional information for StreamingConfigTask WorkItems."
- },
"initialReportIndex": {
"format": "int64",
"description": "The initial index to use when reporting the status of the WorkItem.",
@@ -1989,86 +3096,80 @@
"description": "Additional information for ShellTask WorkItems."
},
"streamingComputationTask": {
- "$ref": "StreamingComputationTask",
- "description": "Additional information for StreamingComputationTask WorkItems."
+ "description": "Additional information for StreamingComputationTask WorkItems.",
+ "$ref": "StreamingComputationTask"
},
"jobId": {
- "type": "string",
- "description": "Identifies the workflow job this WorkItem belongs to."
+ "description": "Identifies the workflow job this WorkItem belongs to.",
+ "type": "string"
},
"id": {
- "type": "string",
"format": "int64",
- "description": "Identifies this WorkItem."
+ "description": "Identifies this WorkItem.",
+ "type": "string"
},
"configuration": {
"description": "Work item-specific configuration as an opaque blob.",
"type": "string"
},
"mapTask": {
- "$ref": "MapTask",
- "description": "Additional information for MapTask WorkItems."
- }
- },
- "id": "WorkItem",
- "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud."
- },
- "StructuredMessage": {
- "type": "object",
- "properties": {
- "messageText": {
- "type": "string",
- "description": "Human-readable version of message."
+ "description": "Additional information for MapTask WorkItems.",
+ "$ref": "MapTask"
},
- "parameters": {
- "description": "The structured data associated with this message.",
+ "seqMapTask": {
+ "description": "Additional information for SeqMapTask WorkItems.",
+ "$ref": "SeqMapTask"
+ },
+ "packages": {
+ "description": "Any required packages that need to be fetched in order to execute\nthis WorkItem.",
"items": {
- "$ref": "Parameter"
+ "$ref": "Package"
},
"type": "array"
- },
- "messageKey": {
- "type": "string",
- "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message."
}
- },
- "id": "StructuredMessage",
- "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption."
- },
- "ReportedParallelism": {
- "type": "object",
- "properties": {
- "isInfinite": {
- "type": "boolean",
- "description": "Specifies whether the parallelism is infinite. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by the current\nJSON-based Java RPC stack."
- },
- "value": {
- "type": "number",
- "format": "double",
- "description": "Specifies the level of parallelism in case it is finite."
- }
- },
- "id": "ReportedParallelism",
- "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker."
+ }
},
"ResourceUtilizationReport": {
+ "id": "ResourceUtilizationReport",
"description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals.",
"type": "object",
"properties": {
"cpuTime": {
+ "description": "CPU utilization samples.",
"items": {
"$ref": "CPUTime"
},
- "type": "array",
- "description": "CPU utilization samples."
+ "type": "array"
+ }
+ }
+ },
+ "ReportedParallelism": {
+ "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
+ "type": "object",
+ "properties": {
+ "isInfinite": {
+ "description": "Specifies whether the parallelism is infinite. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by the current\nJSON-based Java RPC stack.",
+ "type": "boolean"
+ },
+ "value": {
+ "format": "double",
+ "description": "Specifies the level of parallelism in case it is finite.",
+ "type": "number"
}
},
- "id": "ResourceUtilizationReport"
+ "id": "ReportedParallelism"
},
"TopologyConfig": {
"description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.",
"type": "object",
"properties": {
+ "userStageToComputationNameMap": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Maps user stage names to stable computation names.",
+ "type": "object"
+ },
"computations": {
"description": "The computations associated with a streaming Dataflow job.",
"items": {
@@ -2077,50 +3178,44 @@
"type": "array"
},
"persistentStateVersion": {
- "type": "integer",
"format": "int32",
- "description": "Version number for persistent state."
+ "description": "Version number for persistent state.",
+ "type": "integer"
},
"dataDiskAssignments": {
+ "description": "The disks assigned to a streaming Dataflow job.",
"items": {
"$ref": "DataDiskAssignment"
},
- "type": "array",
- "description": "The disks assigned to a streaming Dataflow job."
+ "type": "array"
},
"forwardingKeyBits": {
"format": "int32",
"description": "The size (in bits) of keys that will be assigned to source messages.",
"type": "integer"
- },
- "userStageToComputationNameMap": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Maps user stage names to stable computation names.",
- "type": "object"
}
},
"id": "TopologyConfig"
},
"SourceSplitOptions": {
+ "id": "SourceSplitOptions",
+ "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
"type": "object",
"properties": {
- "desiredBundleSizeBytes": {
- "format": "int64",
- "description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes.",
- "type": "string"
- },
"desiredShardSizeBytes": {
"format": "int64",
"description": "DEPRECATED in favor of desired_bundle_size_bytes.",
"type": "string"
+ },
+ "desiredBundleSizeBytes": {
+ "format": "int64",
+ "description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes.",
+ "type": "string"
}
- },
- "id": "SourceSplitOptions",
- "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest."
+ }
},
"ReadInstruction": {
+ "id": "ReadInstruction",
"description": "An instruction that reads records.\nTakes no inputs, produces one output.",
"type": "object",
"properties": {
@@ -2128,12 +3223,25 @@
"$ref": "Source",
"description": "The source to read from."
}
- },
- "id": "ReadInstruction"
+ }
},
"WorkerSettings": {
+ "id": "WorkerSettings",
+ "description": "Provides data to pass through to the worker harness.",
"type": "object",
"properties": {
+ "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": {
+ "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".",
+ "type": "string"
+ },
"shuffleServicePath": {
"description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".",
"type": "string"
@@ -2145,48 +3253,34 @@
"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": {
- "type": "boolean",
- "description": "Whether to send work progress updates to the service."
- },
- "baseUrl": {
- "description": "The base URL for accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
- "type": "string"
- },
- "servicePath": {
- "type": "string",
- "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\"."
}
- },
- "id": "WorkerSettings",
- "description": "Provides data to pass through to the worker harness."
+ }
},
"DataDiskAssignment": {
+ "id": "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\" }.",
"items": {
"type": "string"
},
- "type": "array",
- "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\" }."
- },
- "vmInstance": {
- "type": "string",
- "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\"."
+ "type": "array"
}
- },
- "id": "DataDiskAssignment",
- "description": "Data disk assignment for a given VM instance."
+ }
},
"StreamingStageLocation": {
"description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication.",
"type": "object",
"properties": {
"streamId": {
- "type": "string",
- "description": "Identifies the particular stream within the streaming Dataflow\njob."
+ "description": "Identifies the particular stream within the streaming Dataflow\njob.",
+ "type": "string"
}
},
"id": "StreamingStageLocation"
@@ -2195,14 +3289,14 @@
"description": "A suggestion by the service to the worker to dynamically split the WorkItem.",
"type": "object",
"properties": {
- "position": {
- "$ref": "Position",
- "description": "A Position at which to split the work item."
- },
"fractionConsumed": {
- "type": "number",
"format": "double",
- "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input)."
+ "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).",
+ "type": "number"
+ },
+ "position": {
+ "description": "A Position at which to split the work item.",
+ "$ref": "Position"
}
},
"id": "ApproximateSplitRequest"
@@ -2217,17 +3311,17 @@
"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 is a common set of\nmessage types for APIs to use.",
"items": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "type": "object"
+ }
},
"type": "array"
}
@@ -2239,15 +3333,28 @@
"type": "object",
"properties": {
"executionStageName": {
- "type": "string",
- "description": "The name of the execution stage."
+ "description": "The name of the execution stage.",
+ "type": "string"
},
"currentStateTime": {
- "type": "string",
"format": "google-datetime",
- "description": "The time at which the stage transitioned to this state."
+ "description": "The time at which the stage transitioned to this state.",
+ "type": "string"
},
"executionStageState": {
+ "enumDescriptions": [
+ "The job's run state isn't specified.",
+ "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
+ "`JOB_STATE_RUNNING` indicates that the job is currently running.",
+ "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
+ "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
+ "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
+ "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
+ "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
+ "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
+ "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
+ "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
+ ],
"enum": [
"JOB_STATE_UNKNOWN",
"JOB_STATE_STOPPED",
@@ -2262,30 +3369,19 @@
"JOB_STATE_CANCELLING"
],
"description": "Executions stage states allow the same set of values as JobState.",
- "type": "string",
- "enumDescriptions": [
- "The job's run state isn't specified.",
- "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
- "`JOB_STATE_RUNNING` indicates that the job is currently running.",
- "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
- "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
- "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
- "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
- "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
- "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
- "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
- "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
- ]
+ "type": "string"
}
},
"id": "ExecutionStageState"
},
"StreamLocation": {
+ "id": "StreamLocation",
+ "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.",
"type": "object",
"properties": {
"customSourceLocation": {
- "$ref": "CustomSourceLocation",
- "description": "The stream is a custom source."
+ "description": "The stream is a custom source.",
+ "$ref": "CustomSourceLocation"
},
"sideInputLocation": {
"$ref": "StreamingSideInputLocation",
@@ -2299,71 +3395,86 @@
"$ref": "StreamingStageLocation",
"description": "The stream is part of another computation within the current\nstreaming Dataflow job."
}
- },
- "id": "StreamLocation",
- "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job."
+ }
},
"SendWorkerMessagesResponse": {
+ "description": "The response to the worker messages.",
"type": "object",
"properties": {
"workerMessageResponses": {
+ "description": "The servers response to the worker messages.",
"items": {
"$ref": "WorkerMessageResponse"
},
- "type": "array",
- "description": "The servers response to the worker messages."
+ "type": "array"
}
},
- "id": "SendWorkerMessagesResponse",
- "description": "The response to the worker messages."
+ "id": "SendWorkerMessagesResponse"
},
- "LeaseWorkItemResponse": {
+ "StreamingComputationConfig": {
+ "id": "StreamingComputationConfig",
+ "description": "Configuration information for a single streaming computation.",
"type": "object",
"properties": {
- "workItems": {
+ "instructions": {
+ "description": "Instructions that comprise the computation.",
"items": {
- "$ref": "WorkItem"
+ "$ref": "ParallelInstruction"
},
- "type": "array",
- "description": "A list of the leased WorkItems."
+ "type": "array"
+ },
+ "computationId": {
+ "description": "Unique identifier for this computation.",
+ "type": "string"
+ },
+ "stageName": {
+ "description": "Stage name of this computation.",
+ "type": "string"
+ },
+ "systemName": {
+ "description": "System defined name for this computation.",
+ "type": "string"
}
- },
- "id": "LeaseWorkItemResponse",
- "description": "Response to a request to lease WorkItems."
+ }
},
"TransformSummary": {
+ "description": "Description of the type, names/ids, and input/outputs for a transform.",
"type": "object",
"properties": {
- "inputCollectionName": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "User names for all collection inputs to this transform."
- },
"name": {
- "type": "string",
- "description": "User provided name for this transform instance."
+ "description": "User provided name for this transform instance.",
+ "type": "string"
},
"id": {
"description": "SDK generated id of this transform instance.",
"type": "string"
},
"displayData": {
+ "description": "Transform-specific display data.",
"items": {
"$ref": "DisplayData"
},
- "type": "array",
- "description": "Transform-specific display data."
+ "type": "array"
},
"outputCollectionName": {
+ "description": "User names for all collection outputs to this transform.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "User names for all collection outputs to this transform."
+ "type": "array"
},
"kind": {
+ "enumDescriptions": [
+ "Unrecognized transform type.",
+ "ParDo transform.",
+ "Group By Key transform.",
+ "Flatten transform.",
+ "Read transform.",
+ "Write transform.",
+ "Constructs from a constant value, such as with Create.of.",
+ "Creates a Singleton view of a collection.",
+ "Opening or closing a shuffle session, often as part of a GroupByKey."
+ ],
"enum": [
"UNKNOWN_KIND",
"PAR_DO_KIND",
@@ -2376,50 +3487,57 @@
"SHUFFLE_KIND"
],
"description": "Type of transform.",
- "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"
+ },
+ "inputCollectionName": {
+ "description": "User names for all collection inputs to this transform.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "TransformSummary",
- "description": "Description of the type, names/ids, and input/outputs for a transform."
+ "id": "TransformSummary"
},
- "StreamingComputationConfig": {
- "description": "Configuration information for a single streaming computation.",
+ "LeaseWorkItemResponse": {
+ "description": "Response to a request to lease WorkItems.",
"type": "object",
"properties": {
- "stageName": {
- "type": "string",
- "description": "Stage name of this computation."
- },
- "systemName": {
- "type": "string",
- "description": "System defined name for this computation."
- },
- "instructions": {
+ "workItems": {
+ "description": "A list of the leased WorkItems.",
"items": {
- "$ref": "ParallelInstruction"
+ "$ref": "WorkItem"
},
- "type": "array",
- "description": "Instructions that comprise the computation."
- },
- "computationId": {
- "type": "string",
- "description": "Unique identifier for this computation."
+ "type": "array"
}
},
- "id": "StreamingComputationConfig"
+ "id": "LeaseWorkItemResponse"
+ },
+ "LaunchTemplateParameters": {
+ "id": "LaunchTemplateParameters",
+ "description": "Parameters to provide to the template being launched.",
+ "type": "object",
+ "properties": {
+ "environment": {
+ "$ref": "RuntimeEnvironment",
+ "description": "The runtime environment for the job."
+ },
+ "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"
+ }
+ }
},
"Sink": {
+ "id": "Sink",
+ "description": "A sink that records can be encoded and written to.",
"type": "object",
"properties": {
"codec": {
@@ -2431,96 +3549,97 @@
"type": "object"
},
"spec": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
- "description": "The sink to write to, plus its parameters."
- }
- },
- "id": "Sink",
- "description": "A sink that records can be encoded and written to."
- },
- "LaunchTemplateParameters": {
- "type": "object",
- "properties": {
- "jobName": {
- "type": "string",
- "description": "Required. The job name to use for the created job."
- },
- "environment": {
- "$ref": "RuntimeEnvironment",
- "description": "The runtime environment for the job."
- },
- "parameters": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The runtime parameters to pass to the job.",
+ "description": "The sink to write to, plus its parameters.",
"type": "object"
}
- },
- "id": "LaunchTemplateParameters",
- "description": "Parameters to provide to the template being launched."
+ }
},
"FlattenInstruction": {
+ "description": "An instruction that copies its inputs (zero or more) to its (single) output.",
"type": "object",
"properties": {
"inputs": {
+ "description": "Describes the inputs to the flatten instruction.",
"items": {
"$ref": "InstructionInput"
},
- "type": "array",
- "description": "Describes the inputs to the flatten instruction."
+ "type": "array"
}
},
- "id": "FlattenInstruction",
- "description": "An instruction that copies its inputs (zero or more) to its (single) output."
+ "id": "FlattenInstruction"
},
"PartialGroupByKeyInstruction": {
"description": "An instruction that does a partial group-by-key.\nOne input and one output.",
"type": "object",
"properties": {
- "sideInputs": {
- "items": {
- "$ref": "SideInputInfo"
- },
- "type": "array",
- "description": "Zero or more side inputs."
- },
- "originalCombineValuesStepName": {
- "type": "string",
- "description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction."
- },
- "input": {
- "$ref": "InstructionInput",
- "description": "Describes the input to the partial group-by-key instruction."
- },
"inputElementCodec": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
"description": "The codec to use for interpreting an element in the input PTable.",
- "type": "object"
- },
- "valueCombiningFn": {
"type": "object",
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "valueCombiningFn": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
},
- "description": "The value combining function to invoke."
+ "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"
+ },
+ "originalCombineValuesStepName": {
+ "description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction.",
+ "type": "string"
+ },
+ "sideInputs": {
+ "description": "Zero or more side inputs.",
+ "items": {
+ "$ref": "SideInputInfo"
+ },
+ "type": "array"
+ },
+ "input": {
+ "description": "Describes the input to the partial group-by-key instruction.",
+ "$ref": "InstructionInput"
}
},
"id": "PartialGroupByKeyInstruction"
},
+ "StageSource": {
+ "description": "Description of an input or output of an execution stage.",
+ "type": "object",
+ "properties": {
+ "sizeBytes": {
+ "format": "int64",
+ "description": "Size of the source, if measurable.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Dataflow service generated name for this source.",
+ "type": "string"
+ },
+ "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"
+ },
"InstructionInput": {
+ "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
"type": "object",
"properties": {
"producerInstructionIndex": {
@@ -2534,32 +3653,7 @@
"type": "integer"
}
},
- "id": "InstructionInput",
- "description": "An input of an instruction, as a reference to an output of a\nproducer instruction."
- },
- "StageSource": {
- "type": "object",
- "properties": {
- "originalTransformOrCollection": {
- "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
- "type": "string"
- },
- "sizeBytes": {
- "type": "string",
- "format": "int64",
- "description": "Size of the source, if measurable."
- },
- "name": {
- "type": "string",
- "description": "Dataflow service generated name for this source."
- },
- "userName": {
- "type": "string",
- "description": "Human-readable name for this source; may be user or system generated."
- }
- },
- "id": "StageSource",
- "description": "Description of an input or output of an execution stage."
+ "id": "InstructionInput"
},
"StringList": {
"description": "A metric value representing a list of strings.",
@@ -2576,39 +3670,9 @@
"id": "StringList"
},
"DisplayData": {
+ "description": "Data provided with a pipeline or transform to provide descriptive info.",
"type": "object",
"properties": {
- "strValue": {
- "type": "string",
- "description": "Contains value if the data is of string type."
- },
- "int64Value": {
- "type": "string",
- "format": "int64",
- "description": "Contains value if the data is of int64 type."
- },
- "durationValue": {
- "type": "string",
- "format": "google-duration",
- "description": "Contains value if the data is of duration type."
- },
- "namespace": {
- "type": "string",
- "description": "The namespace for the key. This is usually a class name or programming\nlanguage namespace (i.e. python module) which defines the display data.\nThis allows a dax monitoring system to specially handle the data\nand perform custom rendering."
- },
- "floatValue": {
- "format": "float",
- "description": "Contains value if the data is of float type.",
- "type": "number"
- },
- "key": {
- "type": "string",
- "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."
- },
- "shortStrValue": {
- "description": "A possible additional shorter value to display.\nFor example a java_class_name_value of com.mypackage.MyDoFn\nwill be stored with MyDoFn as the short_str_value and\ncom.mypackage.MyDoFn as the java_class_name value.\nshort_str_value can be displayed and java_class_name_value\nwill be displayed as a tooltip.",
- "type": "string"
- },
"label": {
"description": "An optional label to display in a dax UI for the element.",
"type": "string"
@@ -2618,62 +3682,54 @@
"type": "string"
},
"timestampValue": {
- "type": "string",
"format": "google-datetime",
- "description": "Contains value if the data is of timestamp type."
+ "description": "Contains value if the data is of timestamp type.",
+ "type": "string"
},
"javaClassValue": {
"description": "Contains value if the data is of java class type.",
"type": "string"
},
"boolValue": {
- "type": "boolean",
- "description": "Contains value if the data is of a boolean type."
- }
- },
- "id": "DisplayData",
- "description": "Data provided with a pipeline or transform to provide descriptive info."
- },
- "LeaseWorkItemRequest": {
- "type": "object",
- "properties": {
- "workItemTypes": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Filter for WorkItem type."
+ "description": "Contains value if the data is of a boolean type.",
+ "type": "boolean"
},
- "location": {
- "description": "The location which contains the WorkItem's job.",
+ "strValue": {
+ "description": "Contains value if the data is of string type.",
"type": "string"
},
- "workerCapabilities": {
- "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "workerId": {
- "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.",
+ "int64Value": {
+ "format": "int64",
+ "description": "Contains value if the data is of int64 type.",
"type": "string"
},
- "requestedLeaseDuration": {
- "type": "string",
+ "durationValue": {
"format": "google-duration",
- "description": "The initial lease period."
+ "description": "Contains value if the data is of duration type.",
+ "type": "string"
},
- "currentWorkerTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The current timestamp at the worker."
+ "namespace": {
+ "description": "The namespace for the key. This is usually a class name or programming\nlanguage namespace (i.e. python module) which defines the display data.\nThis allows a dax monitoring system to specially handle the data\nand perform custom rendering.",
+ "type": "string"
+ },
+ "floatValue": {
+ "format": "float",
+ "description": "Contains value if the data is of float type.",
+ "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"
}
},
- "id": "LeaseWorkItemRequest",
- "description": "Request to lease WorkItems."
+ "id": "DisplayData"
},
"GetDebugConfigRequest": {
+ "id": "GetDebugConfigRequest",
"description": "Request to get updated debug configuration for component.",
"type": "object",
"properties": {
@@ -2686,57 +3742,84 @@
"type": "string"
},
"location": {
- "type": "string",
- "description": "The location which contains the job specified by job_id."
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string"
+ }
+ }
+ },
+ "LeaseWorkItemRequest": {
+ "description": "Request to lease WorkItems.",
+ "type": "object",
+ "properties": {
+ "workerCapabilities": {
+ "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "workerId": {
+ "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.",
+ "type": "string"
+ },
+ "requestedLeaseDuration": {
+ "format": "google-duration",
+ "description": "The initial lease period.",
+ "type": "string"
+ },
+ "currentWorkerTime": {
+ "format": "google-datetime",
+ "description": "The current timestamp at the worker.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The location which contains the WorkItem's job.",
+ "type": "string"
+ },
+ "workItemTypes": {
+ "description": "Filter for WorkItem type.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "GetDebugConfigRequest"
+ "id": "LeaseWorkItemRequest"
},
"GetTemplateResponse": {
+ "id": "GetTemplateResponse",
+ "description": "The response to a GetTemplate request.",
"type": "object",
"properties": {
"status": {
- "$ref": "Status",
- "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details."
+ "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details.",
+ "$ref": "Status"
},
"metadata": {
- "$ref": "TemplateMetadata",
- "description": "The template metadata describing the template name, available\nparameters, etc."
+ "description": "The template metadata describing the template name, available\nparameters, etc.",
+ "$ref": "TemplateMetadata"
}
- },
- "id": "GetTemplateResponse",
- "description": "The response to a GetTemplate request."
+ }
},
"Parameter": {
+ "description": "Structured data associated with this message.",
"type": "object",
"properties": {
- "value": {
- "type": "any",
- "description": "Value for this parameter."
- },
"key": {
- "type": "string",
- "description": "Key or name for this parameter."
+ "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."
+ "id": "Parameter"
},
"ReportWorkItemStatusRequest": {
"description": "Request to report the status of WorkItems.",
"type": "object",
"properties": {
- "location": {
- "type": "string",
- "description": "The location which contains the WorkItem's job."
- },
- "workItemStatuses": {
- "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here.",
- "items": {
- "$ref": "WorkItemStatus"
- },
- "type": "array"
- },
"currentWorkerTime": {
"format": "google-datetime",
"description": "The current timestamp at the worker.",
@@ -2745,46 +3828,25 @@
"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"
+ },
+ "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.",
+ "items": {
+ "$ref": "WorkItemStatus"
+ },
+ "type": "array"
}
},
"id": "ReportWorkItemStatusRequest"
},
- "PipelineDescription": {
- "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.",
- "type": "object",
- "properties": {
- "originalPipelineTransform": {
- "items": {
- "$ref": "TransformSummary"
- },
- "type": "array",
- "description": "Description of each transform in the pipeline and collections between them."
- },
- "displayData": {
- "items": {
- "$ref": "DisplayData"
- },
- "type": "array",
- "description": "Pipeline level display data."
- },
- "executionPipelineStage": {
- "items": {
- "$ref": "ExecutionStageSummary"
- },
- "type": "array",
- "description": "Description of each stage of execution of the pipeline."
- }
- },
- "id": "PipelineDescription"
- },
"StreamingConfigTask": {
+ "description": "A task that carries configuration information for streaming computations.",
"type": "object",
"properties": {
- "windmillServicePort": {
- "format": "int64",
- "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_service_endpoint is\nspecified.",
- "type": "string"
- },
"streamingComputationConfigs": {
"description": "Set of computation configuration information.",
"items": {
@@ -2797,31 +3859,64 @@
"type": "string"
},
"userStepToStateFamilyNameMap": {
+ "description": "Map from user step names to state families.",
"type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Map from user step names to state families."
+ }
+ },
+ "windmillServicePort": {
+ "format": "int64",
+ "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_service_endpoint is\nspecified.",
+ "type": "string"
}
},
- "id": "StreamingConfigTask",
- "description": "A task that carries configuration information for streaming computations."
+ "id": "StreamingConfigTask"
+ },
+ "PipelineDescription": {
+ "id": "PipelineDescription",
+ "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.",
+ "type": "object",
+ "properties": {
+ "executionPipelineStage": {
+ "description": "Description of each stage of execution of the pipeline.",
+ "items": {
+ "$ref": "ExecutionStageSummary"
+ },
+ "type": "array"
+ },
+ "originalPipelineTransform": {
+ "description": "Description of each transform in the pipeline and collections between them.",
+ "items": {
+ "$ref": "TransformSummary"
+ },
+ "type": "array"
+ },
+ "displayData": {
+ "description": "Pipeline level display data.",
+ "items": {
+ "$ref": "DisplayData"
+ },
+ "type": "array"
+ }
+ }
},
"JobExecutionInfo": {
+ "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.",
"type": "object",
"properties": {
"stages": {
+ "description": "A mapping from each stage to the information about that stage.",
+ "type": "object",
"additionalProperties": {
"$ref": "JobExecutionStageInfo"
- },
- "description": "A mapping from each stage to the information about that stage.",
- "type": "object"
+ }
}
},
- "id": "JobExecutionInfo",
- "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job."
+ "id": "JobExecutionInfo"
},
"Step": {
+ "description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.",
"type": "object",
"properties": {
"name": {
@@ -2841,8 +3936,7 @@
"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."
+ "id": "Step"
},
"FailedLocation": {
"description": "Indicates which location failed to respond to a request for data.",
@@ -2856,6 +3950,7 @@
"id": "FailedLocation"
},
"Disk": {
+ "description": "Describes the data disk used by a workflow job.",
"type": "object",
"properties": {
"diskType": {
@@ -2868,43 +3963,74 @@
"type": "integer"
},
"mountPoint": {
- "type": "string",
- "description": "Directory in a VM where disk is mounted."
+ "description": "Directory in a VM where disk is mounted.",
+ "type": "string"
}
},
- "id": "Disk",
- "description": "Describes the data disk used by a workflow job."
+ "id": "Disk"
},
"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": {
+ "description": "Autoscaling events in ascending timestamp order.",
"items": {
"$ref": "AutoscalingEvent"
},
- "type": "array",
- "description": "Autoscaling events in ascending timestamp order."
+ "type": "array"
},
"jobMessages": {
+ "description": "Messages in ascending timestamp order.",
"items": {
"$ref": "JobMessage"
},
- "type": "array",
- "description": "Messages in ascending timestamp order."
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The token to obtain the next page of results if there are more.",
+ "type": "string"
}
},
"id": "ListJobMessagesResponse"
},
"CounterMetadata": {
+ "id": "CounterMetadata",
"description": "CounterMetadata includes all static non-name non-value counter attributes.",
"type": "object",
"properties": {
+ "description": {
+ "description": "Human-readable description of the counter semantics.",
+ "type": "string"
+ },
+ "kind": {
+ "enumDescriptions": [
+ "Counter aggregation kind was not set.",
+ "Aggregated value is the sum of all contributed values.",
+ "Aggregated value is the max of all contributed values.",
+ "Aggregated value is the min of all contributed values.",
+ "Aggregated value is the mean of all contributed values.",
+ "Aggregated value represents the logical 'or' of all contributed values.",
+ "Aggregated value represents the logical 'and' of all contributed values.",
+ "Aggregated value is a set of unique contributed values.",
+ "Aggregated value captures statistics about a distribution."
+ ],
+ "enum": [
+ "INVALID",
+ "SUM",
+ "MAX",
+ "MIN",
+ "MEAN",
+ "OR",
+ "AND",
+ "SET",
+ "DISTRIBUTION"
+ ],
+ "description": "Counter aggregation kind.",
+ "type": "string"
+ },
"standardUnits": {
+ "description": "System defined Units, see above enum.",
"type": "string",
"enumDescriptions": [
"Counter returns a value in bytes.",
@@ -2925,57 +4051,22 @@
"TIMESTAMP_MSEC",
"TIMESTAMP_USEC",
"TIMESTAMP_NSEC"
- ],
- "description": "System defined Units, see above enum."
+ ]
},
"otherUnits": {
- "type": "string",
- "description": "A string referring to the unit type."
- },
- "description": {
- "type": "string",
- "description": "Human-readable description of the counter semantics."
- },
- "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."
- ]
+ "description": "A string referring to the unit type.",
+ "type": "string"
}
- },
- "id": "CounterMetadata"
+ }
},
"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": {
"format": "double",
@@ -2983,28 +4074,18 @@
"type": "number"
},
"consumedParallelism": {
- "$ref": "ReportedParallelism",
- "description": "Total amount of parallelism in the portion of input of this task that has\nalready been consumed and is no longer active. In the first two examples\nabove (see remaining_parallelism), the value should be 29 or 2\nrespectively. The sum of remaining_parallelism and consumed_parallelism\nshould equal the total amount of parallelism in this work item. If\nspecified, must be finite."
- }
- },
- "id": "ApproximateReportedProgress"
- },
- "StateFamilyConfig": {
- "description": "State family configuration.",
- "type": "object",
- "properties": {
- "stateFamily": {
- "type": "string",
- "description": "The state family value."
+ "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"
},
- "isRead": {
- "description": "If true, this family corresponds to a read operation.",
- "type": "boolean"
+ "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": "StateFamilyConfig"
+ }
},
"IntegerList": {
+ "id": "IntegerList",
+ "description": "A metric value representing a list of integers.",
"type": "object",
"properties": {
"elements": {
@@ -3014,9 +4095,22 @@
},
"type": "array"
}
- },
- "id": "IntegerList",
- "description": "A metric value representing a list of integers."
+ }
+ },
+ "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"
+ }
+ }
},
"ResourceUtilizationReportResponse": {
"description": "Service-side response to WorkerMessage reporting resource utilization.",
@@ -3025,20 +4119,29 @@
"id": "ResourceUtilizationReportResponse"
},
"SourceSplitResponse": {
+ "id": "SourceSplitResponse",
+ "description": "The response to a SourceSplitRequest.",
"type": "object",
"properties": {
+ "shards": {
+ "description": "DEPRECATED in favor of bundles.",
+ "items": {
+ "$ref": "SourceSplitShard"
+ },
+ "type": "array"
+ },
"outcome": {
- "enum": [
- "SOURCE_SPLIT_OUTCOME_UNKNOWN",
- "SOURCE_SPLIT_OUTCOME_USE_CURRENT",
- "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED"
- ],
"description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split.",
"type": "string",
"enumDescriptions": [
"The source split outcome is unknown, or unspecified.",
"The current source should be processed \"as is\" without splitting.",
"Splitting produced a list of bundles."
+ ],
+ "enum": [
+ "SOURCE_SPLIT_OUTCOME_UNKNOWN",
+ "SOURCE_SPLIT_OUTCOME_USE_CURRENT",
+ "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED"
]
},
"bundles": {
@@ -3047,19 +4150,11 @@
"$ref": "DerivedSource"
},
"type": "array"
- },
- "shards": {
- "items": {
- "$ref": "SourceSplitShard"
- },
- "type": "array",
- "description": "DEPRECATED in favor of bundles."
}
- },
- "id": "SourceSplitResponse",
- "description": "The response to a SourceSplitRequest."
+ }
},
"ParallelInstruction": {
+ "id": "ParallelInstruction",
"description": "Describes a particular operation comprising a MapTask.",
"type": "object",
"properties": {
@@ -3082,28 +4177,27 @@
"$ref": "ReadInstruction",
"description": "Additional information for Read instructions."
},
+ "originalName": {
+ "description": "System-defined name for the operation in the original workflow graph.",
+ "type": "string"
+ },
"flatten": {
"$ref": "FlattenInstruction",
"description": "Additional information for Flatten instructions."
},
- "originalName": {
- "type": "string",
- "description": "System-defined name for the operation in the original workflow graph."
- },
"systemName": {
"description": "System-defined name of this operation.\nUnique across the workflow.",
"type": "string"
},
"write": {
- "$ref": "WriteInstruction",
- "description": "Additional information for Write instructions."
+ "description": "Additional information for Write instructions.",
+ "$ref": "WriteInstruction"
},
"partialGroupByKey": {
- "$ref": "PartialGroupByKeyInstruction",
- "description": "Additional information for PartialGroupByKey instructions."
+ "description": "Additional information for PartialGroupByKey instructions.",
+ "$ref": "PartialGroupByKeyInstruction"
}
- },
- "id": "ParallelInstruction"
+ }
},
"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.",
@@ -3121,33 +4215,39 @@
"id": "Package"
},
"KeyRangeDataDiskAssignment": {
+ "id": "KeyRangeDataDiskAssignment",
+ "description": "Data disk assignment information for a specific key-range of a sharded\ncomputation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
"type": "object",
"properties": {
+ "end": {
+ "description": "The end (exclusive) 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"
},
"start": {
- "type": "string",
- "description": "The start (inclusive) of the key range."
- },
- "end": {
- "description": "The end (exclusive) of the key range.",
+ "description": "The start (inclusive) of the key range.",
"type": "string"
}
- },
- "id": "KeyRangeDataDiskAssignment",
- "description": "Data disk assignment information for a specific key-range of a sharded\ncomputation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON."
+ }
},
"ParDoInstruction": {
+ "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": {
+ "format": "int32",
+ "description": "The number of outputs.",
+ "type": "integer"
+ },
"sideInputs": {
+ "description": "Zero or more side inputs.",
"items": {
"$ref": "SideInputInfo"
},
- "type": "array",
- "description": "Zero or more side inputs."
+ "type": "array"
},
"multiOutputInfos": {
"description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
@@ -3157,51 +4257,52 @@
"type": "array"
},
"userFn": {
- "type": "object",
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
+ "description": "Properties of the object.",
+ "type": "any"
},
- "description": "The user function to invoke."
+ "description": "The user function to invoke.",
+ "type": "object"
},
"input": {
- "$ref": "InstructionInput",
- "description": "The input."
- },
- "numOutputs": {
- "format": "int32",
- "description": "The number of outputs.",
- "type": "integer"
+ "description": "The input.",
+ "$ref": "InstructionInput"
}
},
- "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."
+ "id": "ParDoInstruction"
},
"CounterStructuredName": {
+ "id": "CounterStructuredName",
+ "description": "Identifies a counter within a per-job namespace. Counters whose structured\nnames are the same get merged into a single value for the job.",
"type": "object",
"properties": {
+ "portion": {
+ "enumDescriptions": [
+ "Counter portion has not been set.",
+ "Counter reports a key.",
+ "Counter reports a value."
+ ],
+ "enum": [
+ "ALL",
+ "KEY",
+ "VALUE"
+ ],
+ "description": "Portion of this counter, either key or value.",
+ "type": "string"
+ },
"originalStepName": {
"description": "System generated name of the original step in the user's graph, before\noptimization.",
"type": "string"
},
"workerId": {
- "type": "string",
- "description": "ID of a particular worker."
+ "description": "ID of a particular worker.",
+ "type": "string"
},
"originNamespace": {
"description": "A string containing a more specific namespace of the counter's origin.",
"type": "string"
},
- "executionStepName": {
- "description": "Name of the stage. An execution step contains multiple component steps.",
- "type": "string"
- },
- "name": {
- "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.",
- "type": "string"
- },
"origin": {
- "type": "string",
"enumDescriptions": [
"Counter was created by the Dataflow system.",
"Counter was created by the user."
@@ -3210,65 +4311,34 @@
"SYSTEM",
"USER"
],
- "description": "One of the standard Origins defined above."
- },
- "componentStepName": {
- "type": "string",
- "description": "Name of the optimized step being executed by the workers."
- },
- "portion": {
- "enum": [
- "ALL",
- "KEY",
- "VALUE"
- ],
- "description": "Portion of this counter, either key or value.",
- "type": "string",
- "enumDescriptions": [
- "Counter portion has not been set.",
- "Counter reports a key.",
- "Counter reports a value."
- ]
- }
- },
- "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": {
- "type": "object",
- "properties": {
- "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": {
- "type": "any",
- "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."
- },
- "updateTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API."
+ "description": "One of the standard Origins defined above.",
+ "type": "string"
},
"name": {
- "$ref": "MetricStructuredName",
- "description": "Name of the metric."
+ "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.",
+ "type": "string"
},
- "distribution": {
- "description": "A struct value describing properties of a distribution of numeric values.",
+ "executionStepName": {
+ "description": "Name of the stage. An execution step contains multiple component steps.",
+ "type": "string"
+ },
+ "componentStepName": {
+ "description": "Name of the optimized step being executed by the workers.",
+ "type": "string"
+ }
+ }
+ },
+ "MetricUpdate": {
+ "description": "Describes the state of a metric.",
+ "type": "object",
+ "properties": {
+ "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"
},
- "set": {
- "type": "any",
- "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type."
- },
"cumulative": {
- "type": "boolean",
- "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."
+ "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.",
@@ -3277,33 +4347,58 @@
"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": {
+ "format": "google-datetime",
+ "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API.",
+ "type": "string"
+ },
+ "name": {
+ "$ref": "MetricStructuredName",
+ "description": "Name of the metric."
+ },
+ "distribution": {
+ "description": "A struct value describing properties of a distribution of numeric values.",
+ "type": "any"
}
},
- "id": "MetricUpdate",
- "description": "Describes the state of a metric."
+ "id": "MetricUpdate"
},
"ApproximateProgress": {
+ "id": "ApproximateProgress",
+ "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.",
"type": "object",
"properties": {
- "percentComplete": {
- "type": "number",
- "format": "float",
+ "position": {
+ "$ref": "Position",
"description": "Obsolete."
},
+ "percentComplete": {
+ "format": "float",
+ "description": "Obsolete.",
+ "type": "number"
+ },
"remainingTime": {
"format": "google-duration",
"description": "Obsolete.",
"type": "string"
- },
- "position": {
- "$ref": "Position",
- "description": "Obsolete."
}
- },
- "id": "ApproximateProgress",
- "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest."
+ }
},
"WorkerMessageResponse": {
+ "description": "A worker_message response allows the server to pass information to the\nsender.",
"type": "object",
"properties": {
"workerMetricsResponse": {
@@ -3315,8 +4410,7 @@
"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.",
@@ -3330,35 +4424,27 @@
"type": "array"
},
"name": {
- "type": "string",
- "description": "Required. The name of the template."
+ "description": "Required. The name of the template.",
+ "type": "string"
},
"description": {
- "type": "string",
- "description": "Optional. A description of the template."
+ "description": "Optional. A description of the template.",
+ "type": "string"
}
},
"id": "TemplateMetadata"
},
"WorkerMessage": {
+ "description": "WorkerMessage provides information to the backend about a worker.",
"type": "object",
"properties": {
- "time": {
- "type": "string",
- "format": "google-datetime",
- "description": "The timestamp of the worker_message."
- },
- "workerHealthReport": {
- "$ref": "WorkerHealthReport",
- "description": "The health of a worker."
- },
"workerMetrics": {
- "$ref": "ResourceUtilizationReport",
- "description": "Resource metrics reported by workers."
+ "description": "Resource metrics reported by workers.",
+ "$ref": "ResourceUtilizationReport"
},
"workerMessageCode": {
- "$ref": "WorkerMessageCode",
- "description": "A worker message code."
+ "description": "A worker message code.",
+ "$ref": "WorkerMessageCode"
},
"labels": {
"additionalProperties": {
@@ -3366,111 +4452,120 @@
},
"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"
+ },
+ "time": {
+ "format": "google-datetime",
+ "description": "The timestamp of the worker_message.",
+ "type": "string"
+ },
+ "workerHealthReport": {
+ "description": "The health of a worker.",
+ "$ref": "WorkerHealthReport"
}
},
- "id": "WorkerMessage",
- "description": "WorkerMessage provides information to the backend about a worker."
+ "id": "WorkerMessage"
},
"JobMetrics": {
+ "description": "JobMetrics contains a collection of metrics descibing the detailed progress\nof a Dataflow job. Metrics correspond to user-defined and system-defined\nmetrics in the job.\n\nThis resource captures only the most recent values of each metric;\ntime-series data can be queried for them (under the same metric names)\nfrom Cloud Monitoring.",
"type": "object",
"properties": {
"metrics": {
+ "description": "All metrics for this job.",
"items": {
"$ref": "MetricUpdate"
},
- "type": "array",
- "description": "All metrics for this job."
+ "type": "array"
},
"metricTime": {
- "type": "string",
"format": "google-datetime",
- "description": "Timestamp as of which metric values are current."
+ "description": "Timestamp as of which metric values are current.",
+ "type": "string"
}
},
- "id": "JobMetrics",
- "description": "JobMetrics contains a collection of metrics descibing the detailed progress\nof a Dataflow job. Metrics correspond to user-defined and system-defined\nmetrics in the job.\n\nThis resource captures only the most recent values of each metric;\ntime-series data can be queried for them (under the same metric names)\nfrom Cloud Monitoring."
+ "id": "JobMetrics"
},
"FloatingPointList": {
+ "description": "A metric value representing a list of floating point numbers.",
"type": "object",
"properties": {
"elements": {
"description": "Elements of the list.",
"items": {
- "type": "number",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"type": "array"
}
},
- "id": "FloatingPointList",
- "description": "A metric value representing a list of floating point numbers."
+ "id": "FloatingPointList"
},
"CounterUpdate": {
+ "id": "CounterUpdate",
"description": "An update to a Counter sent from a worker.",
"type": "object",
"properties": {
- "shortId": {
- "format": "int64",
- "description": "The service-generated short identifier for this counter.\nThe short_id -\u003e (name, metadata) mapping is constant for the lifetime of\na job.",
- "type": "string"
- },
"floatingPointList": {
- "$ref": "FloatingPointList",
- "description": "List of floating point numbers, for Set."
+ "description": "List of floating point numbers, for Set.",
+ "$ref": "FloatingPointList"
},
"integer": {
"$ref": "SplitInt64",
"description": "Integer value for Sum, Max, Min."
},
- "structuredNameAndMetadata": {
- "$ref": "CounterStructuredNameAndMetadata",
- "description": "Counter structured name and metadata."
- },
"integerList": {
"$ref": "IntegerList",
"description": "List of integers, for Set."
},
+ "structuredNameAndMetadata": {
+ "description": "Counter structured name and metadata.",
+ "$ref": "CounterStructuredNameAndMetadata"
+ },
"floatingPoint": {
- "type": "number",
"format": "double",
- "description": "Floating point value for Sum, Max, Min."
+ "description": "Floating point value for Sum, Max, Min.",
+ "type": "number"
},
"integerMean": {
- "$ref": "IntegerMean",
- "description": "Integer mean aggregation value for Mean."
- },
- "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"
+ "description": "Integer mean aggregation value for Mean.",
+ "$ref": "IntegerMean"
},
"internal": {
"description": "Value for internally-defined counters used by the Dataflow service.",
"type": "any"
},
+ "cumulative": {
+ "description": "True if this counter is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this counter is reported\nas a delta.",
+ "type": "boolean"
+ },
"floatingPointMean": {
- "$ref": "FloatingPointMean",
- "description": "Floating point mean aggregation value for Mean."
+ "description": "Floating point mean aggregation value for Mean.",
+ "$ref": "FloatingPointMean"
},
"boolean": {
- "type": "boolean",
- "description": "Boolean value for And, Or."
+ "description": "Boolean value for And, Or.",
+ "type": "boolean"
},
"nameAndKind": {
- "$ref": "NameAndKind",
- "description": "Counter name and aggregation type."
+ "description": "Counter name and aggregation type.",
+ "$ref": "NameAndKind"
},
"distribution": {
"$ref": "DistributionUpdate",
"description": "Distribution data"
},
"stringList": {
- "$ref": "StringList",
- "description": "List of strings, for Set."
+ "description": "List of strings, for Set.",
+ "$ref": "StringList"
+ },
+ "shortId": {
+ "format": "int64",
+ "description": "The service-generated short identifier for this counter.\nThe short_id -\u003e (name, metadata) mapping is constant for the lifetime of\na job.",
+ "type": "string"
}
- },
- "id": "CounterUpdate"
+ }
},
"SourceMetadata": {
+ "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
"type": "object",
"properties": {
"estimatedSizeBytes": {
@@ -3483,61 +4578,49 @@
"type": "boolean"
},
"producesSortedKeys": {
- "type": "boolean",
- "description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order."
+ "description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order.",
+ "type": "boolean"
}
},
- "id": "SourceMetadata",
- "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc."
+ "id": "SourceMetadata"
},
"DistributionUpdate": {
+ "description": "A metric value representing a distribution.",
"type": "object",
"properties": {
"max": {
- "$ref": "SplitInt64",
- "description": "The maximum value present in the distribution."
+ "description": "The maximum value present in the distribution.",
+ "$ref": "SplitInt64"
},
"logBuckets": {
+ "description": "(Optional) Logarithmic histogram of values.\nEach log may be in no more than one bucket. Order does not matter.",
"items": {
"$ref": "LogBucket"
},
- "type": "array",
- "description": "(Optional) Logarithmic histogram of values.\nEach log may be in no more than one bucket. Order does not matter."
+ "type": "array"
},
"count": {
"$ref": "SplitInt64",
"description": "The count of the number of elements present in the distribution."
},
- "min": {
- "$ref": "SplitInt64",
- "description": "The minimum value present in the distribution."
- },
"sumOfSquares": {
"format": "double",
"description": "Use a double since the sum of squares is likely to overflow int64.",
"type": "number"
},
+ "min": {
+ "description": "The minimum value present in the distribution.",
+ "$ref": "SplitInt64"
+ },
"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."
+ "description": "Use an int64 since we'd prefer the added precision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double.",
+ "$ref": "SplitInt64"
}
},
- "id": "DistributionUpdate",
- "description": "A metric value representing a distribution."
- },
- "WorkerHealthReportResponse": {
- "type": "object",
- "properties": {
- "reportInterval": {
- "type": "string",
- "format": "google-duration",
- "description": "A positive value indicates the worker should change its reporting interval\nto the specified value.\n\nThe default value of zero means no change in report rate is requested by\nthe server."
- }
- },
- "id": "WorkerHealthReportResponse",
- "description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping."
+ "id": "DistributionUpdate"
},
"SourceFork": {
+ "description": "DEPRECATED in favor of DynamicSourceSplit.",
"type": "object",
"properties": {
"residual": {
@@ -3545,25 +4628,57 @@
"description": "DEPRECATED"
},
"residualSource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
+ "description": "DEPRECATED",
+ "$ref": "DerivedSource"
},
"primary": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
+ "description": "DEPRECATED",
+ "$ref": "SourceSplitShard"
},
"primarySource": {
"$ref": "DerivedSource",
"description": "DEPRECATED"
}
},
- "id": "SourceFork",
- "description": "DEPRECATED in favor of DynamicSourceSplit."
+ "id": "SourceFork"
+ },
+ "WorkerHealthReportResponse": {
+ "description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping.",
+ "type": "object",
+ "properties": {
+ "reportInterval": {
+ "format": "google-duration",
+ "description": "A positive value indicates the worker should change its reporting interval\nto the specified value.\n\nThe default value of zero means no change in report rate is requested by\nthe server.",
+ "type": "string"
+ }
+ },
+ "id": "WorkerHealthReportResponse"
},
"WorkItemStatus": {
"description": "Conveys a worker's progress through the work described by a WorkItem.",
"type": "object",
"properties": {
+ "reportIndex": {
+ "format": "int64",
+ "description": "The report index. When a WorkItem is leased, the lease will\ncontain an initial report index. When a WorkItem's status is\nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service.\n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times before getting back a response. The worker\nshould not submit a subsequent report until the response for the\nprevious report had been received from the service.",
+ "type": "string"
+ },
+ "stopPosition": {
+ "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc.",
+ "$ref": "Position"
+ },
+ "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."
+ },
"counterUpdates": {
"description": "Worker output counters for this WorkItem.",
"items": {
@@ -3576,11 +4691,11 @@
"type": "string"
},
"errors": {
+ "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed.",
"items": {
"$ref": "Status"
},
- "type": "array",
- "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed."
+ "type": "array"
},
"metricUpdates": {
"description": "DEPRECATED in favor of counter_updates.",
@@ -3594,8 +4709,8 @@
"description": "See documentation of stop_position."
},
"sourceOperationResponse": {
- "$ref": "SourceOperationResponse",
- "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation."
+ "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation.",
+ "$ref": "SourceOperationResponse"
},
"progress": {
"$ref": "ApproximateProgress",
@@ -3605,38 +4720,15 @@
"format": "google-duration",
"description": "Amount of time the worker requests for its lease.",
"type": "string"
- },
- "reportIndex": {
- "type": "string",
- "format": "int64",
- "description": "The report index. When a WorkItem is leased, the lease will\ncontain an initial report index. When a WorkItem's status is\nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service.\n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times before getting back a response. The worker\nshould not submit a subsequent report until the response for the\nprevious report had been received from the service."
- },
- "stopPosition": {
- "$ref": "Position",
- "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc."
- },
- "completed": {
- "type": "boolean",
- "description": "True if the WorkItem was completed (successfully or unsuccessfully)."
- },
- "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": {
- "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"
@@ -3644,42 +4736,50 @@
"userName": {
"description": "Human-readable name for this transform; may be user or system generated.",
"type": "string"
+ },
+ "originalTransformOrCollection": {
+ "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
+ "type": "string"
}
- },
- "id": "ComponentSource",
- "description": "Description of an interstitial value between transforms in an execution\nstage."
+ }
},
"WorkItemServiceState": {
+ "id": "WorkItemServiceState",
+ "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
"type": "object",
"properties": {
- "reportStatusInterval": {
- "type": "string",
- "format": "google-duration",
- "description": "New recommended reporting interval."
+ "splitRequest": {
+ "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task.",
+ "$ref": "ApproximateSplitRequest"
},
"suggestedStopPosition": {
"$ref": "Position",
"description": "Obsolete, always empty."
},
+ "reportStatusInterval": {
+ "format": "google-duration",
+ "description": "New recommended reporting interval.",
+ "type": "string"
+ },
"harnessData": {
+ "description": "Other data returned by the service, specific to the particular\nworker harness.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- },
- "description": "Other data returned by the service, specific to the particular\nworker harness.",
- "type": "object"
+ }
},
"leaseExpireTime": {
- "type": "string",
"format": "google-datetime",
- "description": "Time at which the current lease will expire."
+ "description": "Time at which the current lease will expire.",
+ "type": "string"
},
"metricShortId": {
+ "description": "The short ids that workers should use in subsequent metric updates.\nWorkers should strive to use short ids whenever possible, but it is ok\nto request the short_id again if a worker lost track of it\n(e.g. if the worker is recovering from a crash).\nNOTE: it is possible that the response may have short ids for a subset\nof the metrics.",
"items": {
"$ref": "MetricShortId"
},
- "type": "array",
- "description": "The short ids that workers should use in subsequent metric updates.\nWorkers should strive to use short ids whenever possible, but it is ok\nto request the short_id again if a worker lost track of it\n(e.g. if the worker is recovering from a crash).\nNOTE: it is possible that the response may have short ids for a subset\nof the metrics."
+ "type": "array"
},
"nextReportIndex": {
"format": "int64",
@@ -3689,62 +4789,56 @@
"suggestedStopPoint": {
"$ref": "ApproximateProgress",
"description": "DEPRECATED in favor of split_request."
- },
- "splitRequest": {
- "$ref": "ApproximateSplitRequest",
- "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task."
}
- },
- "id": "WorkItemServiceState",
- "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker."
+ }
},
"MetricStructuredName": {
+ "description": "Identifies a metric, by describing the source which generated the\nmetric.",
"type": "object",
"properties": {
- "context": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e."
- },
"name": {
- "type": "string",
- "description": "Worker-defined metric name."
+ "description": "Worker-defined metric name.",
+ "type": "string"
},
"origin": {
"description": "Origin (namespace) of metric name. May be blank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Dataflow service or SDK.",
"type": "string"
+ },
+ "context": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e.",
+ "type": "object"
}
},
- "id": "MetricStructuredName",
- "description": "Identifies a metric, by describing the source which generated the\nmetric."
+ "id": "MetricStructuredName"
},
"SeqMapTaskOutputInfo": {
+ "description": "Information about an output of a SeqMapTask.",
"type": "object",
"properties": {
- "sink": {
- "$ref": "Sink",
- "description": "The sink to write the output value to."
- },
"tag": {
- "type": "string",
- "description": "The id of the TupleTag the user code will tag the output value by."
+ "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."
+ "id": "SeqMapTaskOutputInfo"
},
"JobExecutionStageInfo": {
"description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
"type": "object",
"properties": {
"stepName": {
+ "description": "The steps associated with the execution stage.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage.",
"items": {
"type": "string"
},
- "type": "array",
- "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"
}
},
"id": "JobExecutionStageInfo"
@@ -3758,44 +4852,86 @@
"type": "string"
},
"deliveryEndpoint": {
- "type": "string",
- "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery."
+ "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.",
+ "type": "string"
},
"dataDisk": {
- "type": "string",
- "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\"."
+ "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
+ "type": "string"
},
"start": {
- "type": "string",
- "description": "The start (inclusive) of the key range."
+ "description": "The start (inclusive) of the key range.",
+ "type": "string"
},
"end": {
- "type": "string",
- "description": "The end (exclusive) of the key range."
+ "description": "The end (exclusive) of the key range.",
+ "type": "string"
}
},
"id": "KeyRangeLocation"
},
"SourceGetMetadataRequest": {
+ "description": "A request to compute the SourceMetadata of a Source.",
"type": "object",
"properties": {
"source": {
- "$ref": "Source",
- "description": "Specification of the source whose metadata should be computed."
+ "description": "Specification of the source whose metadata should be computed.",
+ "$ref": "Source"
}
},
- "id": "SourceGetMetadataRequest",
- "description": "A request to compute the SourceMetadata of a Source."
+ "id": "SourceGetMetadataRequest"
},
- "NameAndKind": {
+ "SeqMapTask": {
+ "id": "SeqMapTask",
+ "description": "Describes a particular function to invoke.",
"type": "object",
"properties": {
"name": {
- "type": "string",
- "description": "Name of the counter."
+ "description": "The user-provided name of the SeqDo operation.",
+ "type": "string"
+ },
+ "outputInfos": {
+ "description": "Information about each of the outputs.",
+ "items": {
+ "$ref": "SeqMapTaskOutputInfo"
+ },
+ "type": "array"
+ },
+ "inputs": {
+ "description": "Information about each of the inputs.",
+ "items": {
+ "$ref": "SideInputInfo"
+ },
+ "type": "array"
+ },
+ "systemName": {
+ "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "stageName": {
+ "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "userFn": {
+ "description": "The user function to invoke.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ }
+ }
+ },
+ "NameAndKind": {
+ "id": "NameAndKind",
+ "description": "Basic metadata about a counter.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the counter.",
+ "type": "string"
},
"kind": {
- "type": "string",
"enumDescriptions": [
"Counter aggregation kind was not set.",
"Aggregated value is the sum of all contributed values.",
@@ -3818,68 +4954,26 @@
"SET",
"DISTRIBUTION"
],
- "description": "Counter aggregation kind."
- }
- },
- "id": "NameAndKind",
- "description": "Basic metadata about a counter."
- },
- "SeqMapTask": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The user-provided name of the SeqDo operation."
- },
- "outputInfos": {
- "items": {
- "$ref": "SeqMapTaskOutputInfo"
- },
- "type": "array",
- "description": "Information about each of the outputs."
- },
- "inputs": {
- "items": {
- "$ref": "SideInputInfo"
- },
- "type": "array",
- "description": "Information about each of the inputs."
- },
- "stageName": {
- "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
+ "description": "Counter aggregation kind.",
"type": "string"
- },
- "systemName": {
- "type": "string",
- "description": "System-defined name of the SeqDo operation.\nUnique across the workflow."
- },
- "userFn": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "The user function to invoke."
}
- },
- "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": {
+ "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": {
"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."
+ }
+ },
+ "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"
@@ -3889,8 +4983,8 @@
"type": "object",
"properties": {
"stateful": {
- "type": "boolean",
- "description": "Whether this source is stateful."
+ "description": "Whether this source is stateful.",
+ "type": "boolean"
}
},
"id": "CustomSourceLocation"
@@ -3916,1122 +5010,18 @@
}
},
"id": "MapTask"
- },
- "FloatingPointMean": {
- "description": "A representation of a floating point mean metric contribution.",
- "type": "object",
- "properties": {
- "count": {
- "$ref": "SplitInt64",
- "description": "The number of values being aggregated."
- },
- "sum": {
- "format": "double",
- "description": "The sum of all values being aggregated.",
- "type": "number"
- }
- },
- "id": "FloatingPointMean"
- },
- "ReportWorkItemStatusResponse": {
- "type": "object",
- "properties": {
- "workItemServiceStates": {
- "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
- "items": {
- "$ref": "WorkItemServiceState"
- },
- "type": "array"
- }
- },
- "id": "ReportWorkItemStatusResponse",
- "description": "Response from a request to report the status of WorkItems."
- },
- "InstructionOutput": {
- "type": "object",
- "properties": {
- "codec": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "The codec to use to encode data being written via this output."
- },
- "name": {
- "type": "string",
- "description": "The user-provided name of this output."
- },
- "originalName": {
- "type": "string",
- "description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this."
- },
- "systemName": {
- "type": "string",
- "description": "System-defined name of this output.\nUnique across the workflow."
- },
- "onlyCountKeyBytes": {
- "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.",
- "type": "boolean"
- },
- "onlyCountValueBytes": {
- "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.",
- "type": "boolean"
- }
- },
- "id": "InstructionOutput",
- "description": "An output of an instruction."
- },
- "CreateJobFromTemplateRequest": {
- "type": "object",
- "properties": {
- "jobName": {
- "type": "string",
- "description": "Required. The job name to use for the created job."
- },
- "gcsPath": {
- "type": "string",
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`."
- },
- "environment": {
- "$ref": "RuntimeEnvironment",
- "description": "The runtime environment for the job."
- },
- "location": {
- "description": "The location to which to direct the request.",
- "type": "string"
- },
- "parameters": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "The runtime parameters to pass to the job."
- }
- },
- "id": "CreateJobFromTemplateRequest",
- "description": "A request to create a Cloud Dataflow job from a template."
- },
- "IntegerMean": {
- "type": "object",
- "properties": {
- "sum": {
- "$ref": "SplitInt64",
- "description": "The sum of all values being aggregated."
- },
- "count": {
- "$ref": "SplitInt64",
- "description": "The number of values being aggregated."
- }
- },
- "id": "IntegerMean",
- "description": "A representation of an integer mean metric contribution."
- },
- "ListJobsResponse": {
- "type": "object",
- "properties": {
- "jobs": {
- "description": "A subset of the requested job information.",
- "items": {
- "$ref": "Job"
- },
- "type": "array"
- },
- "failedLocation": {
- "items": {
- "$ref": "FailedLocation"
- },
- "type": "array",
- "description": "Zero or more messages describing locations that failed to respond."
- },
- "nextPageToken": {
- "description": "Set if there may be more results than fit in this response.",
- "type": "string"
- }
- },
- "id": "ListJobsResponse",
- "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest."
- },
- "ComputationTopology": {
- "type": "object",
- "properties": {
- "systemStageName": {
- "description": "The system stage name.",
- "type": "string"
- },
- "inputs": {
- "description": "The inputs to the computation.",
- "items": {
- "$ref": "StreamLocation"
- },
- "type": "array"
- },
- "computationId": {
- "description": "The ID of the computation.",
- "type": "string"
- },
- "keyRanges": {
- "description": "The key ranges processed by the computation.",
- "items": {
- "$ref": "KeyRangeLocation"
- },
- "type": "array"
- },
- "stateFamilies": {
- "items": {
- "$ref": "StateFamilyConfig"
- },
- "type": "array",
- "description": "The state family values."
- },
- "outputs": {
- "description": "The outputs from the computation.",
- "items": {
- "$ref": "StreamLocation"
- },
- "type": "array"
- }
- },
- "id": "ComputationTopology",
- "description": "All configuration data for a particular Computation."
- },
- "RuntimeEnvironment": {
- "type": "object",
- "properties": {
- "zone": {
- "type": "string",
- "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline."
- },
- "maxWorkers": {
- "format": "int32",
- "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.",
- "type": "integer"
- },
- "serviceAccountEmail": {
- "description": "The email address of the service account to run the job as.",
- "type": "string"
- },
- "tempLocation": {
- "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
- "type": "string"
- },
- "bypassTempDirValidation": {
- "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
- "type": "boolean"
- },
- "machineType": {
- "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
- "type": "string"
- }
- },
- "id": "RuntimeEnvironment",
- "description": "The environment values to set at runtime."
- },
- "MountedDataDisk": {
- "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\"."
- }
- },
- "id": "MountedDataDisk",
- "description": "Describes mounted data disk."
- },
- "StreamingSideInputLocation": {
- "description": "Identifies the location of a streaming side input.",
- "type": "object",
- "properties": {
- "stateFamily": {
- "type": "string",
- "description": "Identifies the state family where this side input is stored."
- },
- "tag": {
- "description": "Identifies the particular side input within the streaming Dataflow job.",
- "type": "string"
- }
- },
- "id": "StreamingSideInputLocation"
- },
- "LaunchTemplateResponse": {
- "type": "object",
- "properties": {
- "job": {
- "$ref": "Job",
- "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched."
- }
- },
- "id": "LaunchTemplateResponse",
- "description": "Response to the request to launch a template."
- },
- "DerivedSource": {
- "type": "object",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Specification of the source."
- },
- "derivationMode": {
- "type": "string",
- "enumDescriptions": [
- "The source derivation is unknown, or unspecified.",
- "Produce a completely independent Source with no base.",
- "Produce a Source based on the Source being split.",
- "Produce a Source based on the base of the Source being split."
- ],
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ],
- "description": "What source to base the produced source on (if any)."
- }
- },
- "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."
- },
- "DynamicSourceSplit": {
- "type": "object",
- "properties": {
- "residual": {
- "$ref": "DerivedSource",
- "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source."
- },
- "primary": {
- "$ref": "DerivedSource",
- "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current."
- }
- },
- "id": "DynamicSourceSplit",
- "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input."
- },
- "Job": {
- "type": "object",
- "properties": {
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string"
- },
- "type": {
- "enum": [
- "JOB_TYPE_UNKNOWN",
- "JOB_TYPE_BATCH",
- "JOB_TYPE_STREAMING"
- ],
- "description": "The type of Cloud Dataflow job.",
- "type": "string",
- "enumDescriptions": [
- "The type of the job is unspecified, or unknown.",
- "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.",
- "A continuously streaming job with no end: data is read,\nprocessed, and written continuously."
- ]
- },
- "pipelineDescription": {
- "$ref": "PipelineDescription",
- "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL."
- },
- "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": {
- "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}",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "clientRequestId": {
- "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`"
- },
- "replacedByJobId": {
- "type": "string",
- "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."
- },
- "steps": {
- "items": {
- "$ref": "Step"
- },
- "type": "array",
- "description": "The top-level steps that constitute the entire job."
- },
- "executionInfo": {
- "$ref": "JobExecutionInfo",
- "description": "Deprecated."
- },
- "id": {
- "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.",
- "type": "string"
- },
- "currentState": {
- "enum": [
- "JOB_STATE_UNKNOWN",
- "JOB_STATE_STOPPED",
- "JOB_STATE_RUNNING",
- "JOB_STATE_DONE",
- "JOB_STATE_FAILED",
- "JOB_STATE_CANCELLED",
- "JOB_STATE_UPDATED",
- "JOB_STATE_DRAINING",
- "JOB_STATE_DRAINED",
- "JOB_STATE_PENDING",
- "JOB_STATE_CANCELLING"
- ],
- "description": "The current state of the job.\n\nJobs are created in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nThis field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
- "type": "string",
- "enumDescriptions": [
- "The job's run state isn't specified.",
- "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
- "`JOB_STATE_RUNNING` indicates that the job is currently running.",
- "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
- "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
- "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
- "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
- "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
- "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
- "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
- "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
- ]
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string"
- },
- "currentStateTime": {
- "format": "google-datetime",
- "description": "The timestamp associated with the current state.",
- "type": "string"
- },
- "transformNameMapping": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job."
- },
- "labels": {
- "type": "object",
- "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."
- },
- "environment": {
- "$ref": "Environment",
- "description": "The environment for the job."
- },
- "createTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service."
- },
- "stageStates": {
- "items": {
- "$ref": "ExecutionStageState"
- },
- "type": "array",
- "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it."
- }
- },
- "id": "Job",
- "description": "Defines a job to be run by the Cloud Dataflow service."
- },
- "SourceOperationResponse": {
- "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
- "type": "object",
- "properties": {
- "split": {
- "$ref": "SourceSplitResponse",
- "description": "A response to a request to split a source."
- },
- "getMetadata": {
- "$ref": "SourceGetMetadataResponse",
- "description": "A response to a request to get metadata about a source."
- }
- },
- "id": "SourceOperationResponse"
- },
- "SendDebugCaptureResponse": {
- "type": "object",
- "properties": {},
- "id": "SendDebugCaptureResponse",
- "description": "Response to a send capture request.\nnothing"
- },
- "SideInputInfo": {
- "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
- "type": "object",
- "properties": {
- "tag": {
- "type": "string",
- "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo."
- },
- "kind": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "How to interpret the source element(s) as a side input value.",
- "type": "object"
- },
- "sources": {
- "items": {
- "$ref": "Source"
- },
- "type": "array",
- "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required."
- }
- },
- "id": "SideInputInfo"
- },
- "WriteInstruction": {
- "type": "object",
- "properties": {
- "input": {
- "$ref": "InstructionInput",
- "description": "The input."
- },
- "sink": {
- "$ref": "Sink",
- "description": "The sink to write to."
- }
- },
- "id": "WriteInstruction",
- "description": "An instruction that writes records.\nTakes one input, produces no outputs."
- },
- "CounterStructuredNameAndMetadata": {
- "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "CounterMetadata",
- "description": "Metadata associated with a counter"
- },
- "name": {
- "$ref": "CounterStructuredName",
- "description": "Structured name of the counter."
- }
- },
- "id": "CounterStructuredNameAndMetadata"
- },
- "ConcatPosition": {
- "description": "A position that encapsulates an inner position and an index for the inner\nposition. A ConcatPosition can be used by a reader of a source that\nencapsulates a set of other sources.",
- "type": "object",
- "properties": {
- "position": {
- "$ref": "Position",
- "description": "Position within the inner source."
- },
- "index": {
- "format": "int32",
- "description": "Index of the inner source.",
- "type": "integer"
- }
- },
- "id": "ConcatPosition"
- },
- "AutoscalingSettings": {
- "description": "Settings for WorkerPool autoscaling.",
- "type": "object",
- "properties": {
- "algorithm": {
- "type": "string",
- "enumDescriptions": [
- "The algorithm is unknown, or unspecified.",
- "Disable autoscaling.",
- "Increase worker count over time to reduce job execution time."
- ],
- "enum": [
- "AUTOSCALING_ALGORITHM_UNKNOWN",
- "AUTOSCALING_ALGORITHM_NONE",
- "AUTOSCALING_ALGORITHM_BASIC"
- ],
- "description": "The algorithm to use for autoscaling."
- },
- "maxNumWorkers": {
- "type": "integer",
- "format": "int32",
- "description": "The maximum number of workers to cap scaling at."
- }
- },
- "id": "AutoscalingSettings"
- },
- "StreamingComputationRanges": {
- "description": "Describes full or partial data disk assignment information of the computation\nranges.",
- "type": "object",
- "properties": {
- "rangeAssignments": {
- "items": {
- "$ref": "KeyRangeDataDiskAssignment"
- },
- "type": "array",
- "description": "Data disk assignments for ranges from this computation."
- },
- "computationId": {
- "description": "The ID of the computation.",
- "type": "string"
- }
- },
- "id": "StreamingComputationRanges"
- },
- "ExecutionStageSummary": {
- "description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning.",
- "type": "object",
- "properties": {
- "inputSource": {
- "items": {
- "$ref": "StageSource"
- },
- "type": "array",
- "description": "Input sources for this stage."
- },
- "id": {
- "type": "string",
- "description": "Dataflow service generated id for this stage."
- },
- "componentTransform": {
- "description": "Transforms that comprise this execution stage.",
- "items": {
- "$ref": "ComponentTransform"
- },
- "type": "array"
- },
- "componentSource": {
- "description": "Collections produced and consumed by component transforms of this stage.",
- "items": {
- "$ref": "ComponentSource"
- },
- "type": "array"
- },
- "kind": {
- "type": "string",
- "enumDescriptions": [
- "Unrecognized transform type.",
- "ParDo transform.",
- "Group By Key transform.",
- "Flatten transform.",
- "Read transform.",
- "Write transform.",
- "Constructs from a constant value, such as with Create.of.",
- "Creates a Singleton view of a collection.",
- "Opening or closing a shuffle session, often as part of a GroupByKey."
- ],
- "enum": [
- "UNKNOWN_KIND",
- "PAR_DO_KIND",
- "GROUP_BY_KEY_KIND",
- "FLATTEN_KIND",
- "READ_KIND",
- "WRITE_KIND",
- "CONSTANT_KIND",
- "SINGLETON_KIND",
- "SHUFFLE_KIND"
- ],
- "description": "Type of tranform this stage is executing."
- },
- "outputSource": {
- "description": "Output sources for this stage.",
- "items": {
- "$ref": "StageSource"
- },
- "type": "array"
- },
- "name": {
- "description": "Dataflow service generated name for this stage.",
- "type": "string"
- }
- },
- "id": "ExecutionStageSummary"
- },
- "LogBucket": {
- "description": "Bucket of values for Distribution's logarithmic histogram.",
- "type": "object",
- "properties": {
- "count": {
- "format": "int64",
- "description": "Number of values in this bucket.",
- "type": "string"
- },
- "log": {
- "format": "int32",
- "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",
- "type": "integer"
- }
- },
- "id": "LogBucket"
- },
- "SendWorkerMessagesRequest": {
- "description": "A request for sending worker messages to the service.",
- "type": "object",
- "properties": {
- "workerMessages": {
- "items": {
- "$ref": "WorkerMessage"
- },
- "type": "array",
- "description": "The WorkerMessages to send."
- },
- "location": {
- "description": "The location which contains the job",
- "type": "string"
- }
- },
- "id": "SendWorkerMessagesRequest"
- },
- "SourceSplitShard": {
- "description": "DEPRECATED in favor of DerivedSource.",
- "type": "object",
- "properties": {
- "derivationMode": {
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ],
- "description": "DEPRECATED",
- "type": "string",
- "enumDescriptions": [
- "The source derivation is unknown, or unspecified.",
- "Produce a completely independent Source with no base.",
- "Produce a Source based on the Source being split.",
- "Produce a Source based on the base of the Source being split."
- ]
- },
- "source": {
- "$ref": "Source",
- "description": "DEPRECATED"
- }
- },
- "id": "SourceSplitShard"
- },
- "CPUTime": {
- "description": "Modeled after information exposed by /proc/stat.",
- "type": "object",
- "properties": {
- "timestamp": {
- "type": "string",
- "format": "google-datetime",
- "description": "Timestamp of the measurement."
- },
- "totalMs": {
- "type": "string",
- "format": "uint64",
- "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up."
- },
- "rate": {
- "format": "double",
- "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
- "type": "number"
- }
- },
- "id": "CPUTime"
- },
- "Environment": {
- "description": "Describes the environment in which a Dataflow Job runs.",
- "type": "object",
- "properties": {
- "userAgent": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "A description of the process that generated the request."
- },
- "sdkPipelineOptions": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The Cloud Dataflow SDK pipeline options specified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and platform\nindependent way."
- },
- "clusterManagerApiService": {
- "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\".",
- "type": "string"
- },
- "tempStoragePrefix": {
- "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
- },
- "workerPools": {
- "items": {
- "$ref": "WorkerPool"
- },
- "type": "array",
- "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers."
- },
- "dataset": {
- "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}",
- "type": "string"
- },
- "experiments": {
- "description": "The list of experiments to enable.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "internalExperiments": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Experimental settings."
- },
- "version": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
- "type": "object"
- },
- "serviceAccountEmail": {
- "description": "Identity to run virtual machines as. Defaults to the default account.",
- "type": "string"
- }
- },
- "id": "Environment"
- },
- "StreamingComputationTask": {
- "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.",
- "type": "object",
- "properties": {
- "computationRanges": {
- "items": {
- "$ref": "StreamingComputationRanges"
- },
- "type": "array",
- "description": "Contains ranges of a streaming computation this task should apply to."
- },
- "dataDisks": {
- "items": {
- "$ref": "MountedDataDisk"
- },
- "type": "array",
- "description": "Describes the set of data disks this task should apply to."
- },
- "taskType": {
- "enum": [
- "STREAMING_COMPUTATION_TASK_UNKNOWN",
- "STREAMING_COMPUTATION_TASK_STOP",
- "STREAMING_COMPUTATION_TASK_START"
- ],
- "description": "A type of streaming computation task.",
- "type": "string",
- "enumDescriptions": [
- "The streaming computation task is unknown, or unspecified.",
- "Stop processing specified streaming computation range(s).",
- "Start processing specified streaming computation range(s)."
- ]
- }
- },
- "id": "StreamingComputationTask"
- },
- "SendDebugCaptureRequest": {
- "description": "Request to send encoded debug information.",
- "type": "object",
- "properties": {
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "type": "string"
- },
- "data": {
- "description": "The encoded debug information.",
- "type": "string"
- },
- "componentId": {
- "type": "string",
- "description": "The internal component id for which debug information is sent."
- },
- "workerId": {
- "type": "string",
- "description": "The worker id, i.e., VM hostname."
- }
- },
- "id": "SendDebugCaptureRequest"
- },
- "GetDebugConfigResponse": {
- "description": "Response to a get debug configuration request.",
- "type": "object",
- "properties": {
- "config": {
- "description": "The encoded debug configuration for the requested component.",
- "type": "string"
- }
- },
- "id": "GetDebugConfigResponse"
- },
- "ComponentTransform": {
- "description": "Description of a transform executed as part of an execution stage.",
- "type": "object",
- "properties": {
- "originalTransform": {
- "description": "User name for the original user transform with which this transform is\nmost closely associated.",
- "type": "string"
- },
- "name": {
- "description": "Dataflow service generated name for this source.",
- "type": "string"
- },
- "userName": {
- "type": "string",
- "description": "Human-readable name for this transform; may be user or system generated."
- }
- },
- "id": "ComponentTransform"
- },
- "StreamingSetupTask": {
- "type": "object",
- "properties": {
- "streamingComputationTopology": {
- "$ref": "TopologyConfig",
- "description": "The global topology of the streaming Dataflow job."
- },
- "drain": {
- "type": "boolean",
- "description": "The user has requested drain."
- },
- "workerHarnessPort": {
- "format": "int32",
- "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
- "type": "integer"
- },
- "receiveWorkPort": {
- "format": "int32",
- "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.",
- "type": "integer"
- }
- },
- "id": "StreamingSetupTask",
- "description": "A task which initializes part of a streaming Dataflow job."
- },
- "PubsubLocation": {
- "type": "object",
- "properties": {
- "withAttributes": {
- "description": "If true, then the client has requested to get pubsub attributes.",
- "type": "boolean"
- },
- "idLabel": {
- "type": "string",
- "description": "If set, contains a pubsub label from which to extract record ids.\nIf left empty, record deduplication will be strictly best effort."
- },
- "topic": {
- "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/\u003cproject-id\u003e/\u003ctopic-name\u003e\"",
- "type": "string"
- },
- "timestampLabel": {
- "type": "string",
- "description": "If set, contains a pubsub label from which to extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival."
- },
- "subscription": {
- "description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/\u003cproject-id\u003e/\u003csubscription-name\u003e\"",
- "type": "string"
- },
- "dropLateData": {
- "type": "boolean",
- "description": "Indicates whether the pipeline allows late-arriving data."
- },
- "trackingSubscription": {
- "description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation.",
- "type": "string"
- }
- },
- "id": "PubsubLocation",
- "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job."
- },
- "WorkerHealthReport": {
- "type": "object",
- "properties": {
- "pods": {
- "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "vmStartupTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The time the VM was booted."
- },
- "reportInterval": {
- "format": "google-duration",
- "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
- "type": "string"
- },
- "vmIsHealthy": {
- "type": "boolean",
- "description": "Whether the VM is healthy."
- }
- },
- "id": "WorkerHealthReport",
- "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": {
- "messageImportance": {
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ],
- "description": "Importance level of the message.",
- "type": "string",
- "enumDescriptions": [
- "The message importance isn't specified, or is unknown.",
- "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.",
- "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
- "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.",
- "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.",
- "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
- ]
- },
- "messageText": {
- "description": "The text of the message.",
- "type": "string"
- },
- "time": {
- "format": "google-datetime",
- "description": "The timestamp of the message.",
- "type": "string"
- },
- "id": {
- "description": "Deprecated.",
- "type": "string"
- }
- },
- "id": "JobMessage"
- },
- "ParameterMetadata": {
- "description": "Metadata for a specific parameter.",
- "type": "object",
- "properties": {
- "helpText": {
- "description": "Required. The help text to display for the parameter.",
- "type": "string"
- },
- "isOptional": {
- "type": "boolean",
- "description": "Optional. Whether the parameter is optional. Defaults to false."
- },
- "name": {
- "type": "string",
- "description": "Required. The name of the parameter."
- },
- "regexes": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Optional. Regexes that the parameter must match."
- },
- "label": {
- "type": "string",
- "description": "Required. The label to display for the parameter."
- }
- },
- "id": "ParameterMetadata"
- },
- "MultiOutputInfo": {
- "type": "object",
- "properties": {
- "tag": {
- "type": "string",
- "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo."
- }
- },
- "id": "MultiOutputInfo",
- "description": "Information about an output of a multi-output DoFn."
- },
- "SourceSplitRequest": {
- "description": "Represents the operation to split a high-level Source specification\ninto bundles (parts for parallel processing).\n\nAt a high level, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
- "type": "object",
- "properties": {
- "options": {
- "$ref": "SourceSplitOptions",
- "description": "Hints for tuning the splitting process."
- },
- "source": {
- "$ref": "Source",
- "description": "Specification of the source to be split."
- }
- },
- "id": "SourceSplitRequest"
- },
- "SourceGetMetadataResponse": {
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "SourceMetadata",
- "description": "The computed metadata."
- }
- },
- "id": "SourceGetMetadataResponse",
- "description": "The result of a SourceGetMetadataOperation."
}
},
+ "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": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/compute.readonly": {
- "description": "View your Google Compute Engine resources"
- },
"https://www.googleapis.com/auth/compute": {
"description": "View and manage your Google Compute Engine resources"
},
@@ -5040,15 +5030,25 @@
},
"https://www.googleapis.com/auth/userinfo.email": {
"description": "View your email address"
+ },
+ "https://www.googleapis.com/auth/compute.readonly": {
+ "description": "View your Google Compute Engine resources"
}
}
}
},
- "servicePath": "",
"description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.",
"kind": "discovery#restDescription",
+ "servicePath": "",
"rootUrl": "https://dataflow.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
- "name": "dataflow"
+ "name": "dataflow",
+ "batchPath": "batch",
+ "id": "dataflow:v1b3",
+ "documentationLink": "https://cloud.google.com/dataflow",
+ "revision": "20170821",
+ "title": "Google Dataflow API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json
index 4ea65c6..d7c62dc 100644
--- a/dataproc/v1/dataproc-api.json
+++ b/dataproc/v1/dataproc-api.json
@@ -1,15 +1,656 @@
{
+ "title": "Google Cloud Dataproc API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "resources": {
+ "projects": {
+ "resources": {
+ "regions": {
+ "resources": {
+ "jobs": {
+ "methods": {
+ "cancel": {
+ "request": {
+ "$ref": "CancelJobRequest"
+ },
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.regions.jobs.cancel",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"
+ },
+ "patch": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates a job in a project.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ },
+ "get": {
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.get",
+ "description": "Gets the resource representation for a job in a project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ]
+ },
+ "submit": {
+ "description": "Submits a job to a cluster.",
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
+ "id": "dataproc.projects.regions.jobs.submit",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs:submit"
+ },
+ "delete": {
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "jobId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Required. The job ID."
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.delete",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ },
+ "list": {
+ "description": "Lists regions/{region}/jobs in a project.",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "jobStateMatcher": {
+ "enum": [
+ "ALL",
+ "ACTIVE",
+ "NON_ACTIVE"
+ ],
+ "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The number of results to return in each response.",
+ "type": "integer"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "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.",
+ "type": "string",
+ "required": true
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs",
+ "id": "dataproc.projects.regions.jobs.list",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs"
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
+ "create": {
+ "id": "dataproc.projects.regions.clusters.create",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
+ "description": "Creates a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Cluster"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to."
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get",
+ "description": "Gets the resource representation for a cluster in a project."
+ },
+ "patch": {
+ "id": "dataproc.projects.regions.clusters.patch",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "description": "Updates a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, only the following fields can be updated:\u003ctable\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003eMask\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003e\u003cstrong\u003ePurpose\u003c/strong\u003e\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003elabels\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eUpdate labels\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize primary worker group\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.secondary_worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize secondary worker group\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e",
+ "type": "string"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "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"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "id": "dataproc.projects.regions.clusters.diagnose",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose"
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.delete",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "description": "Deletes a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "clusterName": {
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists all regions/{region}/clusters in a project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The standard List page size.",
+ "type": "integer"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true,
+ "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"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. The standard List page token.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.list"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "dataproc.projects.regions.operations.cancel"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "id": "dataproc.projects.regions.operations.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "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."
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations$",
+ "location": "path",
+ "description": "The name of the operation's parent resource."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
+ "path": "v1/{+name}",
+ "id": "dataproc.projects.regions.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"parameters": {
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
"prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
},
"uploadType": {
"location": "query",
@@ -17,9 +658,9 @@
"type": "string"
},
"fields": {
+ "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "description": "Selector specifying which fields to include in a partial response."
},
"callback": {
"description": "JSONP",
@@ -40,6 +681,8 @@
"type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -51,9 +694,7 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "location": "query"
},
"access_token": {
"location": "query",
@@ -82,176 +723,17 @@
"location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
}
},
"schemas": {
- "ClusterMetrics": {
- "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "type": "object",
- "properties": {
- "yarnMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The YARN metrics.",
- "type": "object"
- },
- "hdfsMetrics": {
- "description": "The HDFS metrics.",
- "type": "object",
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- }
- }
- },
- "id": "ClusterMetrics"
- },
- "AcceleratorConfig": {
- "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
- "type": "object",
- "properties": {
- "acceleratorCount": {
- "format": "int32",
- "description": "The number of the accelerator cards of this type exposed to this instance.",
- "type": "integer"
- },
- "acceleratorTypeUri": {
- "type": "string",
- "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80"
- }
- },
- "id": "AcceleratorConfig"
- },
- "LoggingConfig": {
- "properties": {
- "driverLogLevels": {
- "additionalProperties": {
- "enum": [
- "LEVEL_UNSPECIFIED",
- "ALL",
- "TRACE",
- "DEBUG",
- "INFO",
- "WARN",
- "ERROR",
- "FATAL",
- "OFF"
- ],
- "type": "string"
- },
- "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
- "type": "object"
- }
- },
- "id": "LoggingConfig",
- "description": "The runtime logging config of the job.",
- "type": "object"
- },
- "Operation": {
- "properties": {
- "name": {
- "type": "string",
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of 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 contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object"
- },
- "JobReference": {
- "description": "Encapsulates the full scoping used to reference a job.",
- "type": "object",
- "properties": {
- "jobId": {
- "description": "Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
- "type": "string"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string"
- }
- },
- "id": "JobReference"
- },
- "SubmitJobRequest": {
- "id": "SubmitJobRequest",
- "description": "A request to submit a job.",
- "type": "object",
- "properties": {
- "job": {
- "description": "Required. The job resource.",
- "$ref": "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": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- }
- },
- "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": {
- "format": "int32",
- "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
- "type": "integer"
- }
- },
- "id": "JobScheduling"
- },
"InstanceGroupConfig": {
"description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
"type": "object",
@@ -273,8 +755,8 @@
"$ref": "DiskConfig"
},
"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"
+ "$ref": "ManagedGroupConfig",
+ "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups."
},
"isPreemptible": {
"description": "Optional. Specifies that this instance group contains preemptible instances.",
@@ -298,40 +780,52 @@
},
"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": {
+ "format": "int32",
+ "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
+ "type": "integer"
+ }
+ },
+ "id": "JobScheduling"
+ },
+ "NodeInitializationAction": {
+ "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
+ "type": "object",
+ "properties": {
+ "executableFile": {
+ "description": "Required. Google Cloud Storage URI of executable file.",
+ "type": "string"
+ },
+ "executionTimeout": {
+ "format": "google-duration",
+ "description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
+ "type": "string"
+ }
+ },
+ "id": "NodeInitializationAction"
+ },
"ListJobsResponse": {
"description": "A list of jobs in a project.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
+ "type": "string"
+ },
"jobs": {
"description": "Output-only. Jobs list.",
"items": {
"$ref": "Job"
},
"type": "array"
- },
- "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": {
- "id": "NodeInitializationAction",
- "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
- "type": "object",
- "properties": {
- "executionTimeout": {
- "format": "google-duration",
- "description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
- "type": "string"
- },
- "executableFile": {
- "type": "string",
- "description": "Required. Google Cloud Storage URI of executable file."
- }
- }
- },
"CancelJobRequest": {
"description": "A request to cancel a job.",
"type": "object",
@@ -339,8 +833,17 @@
"id": "CancelJobRequest"
},
"SparkSqlJob": {
+ "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"
+ },
"scriptVariables": {
"additionalProperties": {
"type": "string"
@@ -356,8 +859,8 @@
"type": "array"
},
"loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
},
"properties": {
"type": "object",
@@ -365,18 +868,9 @@
"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."
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains SQL queries.",
- "type": "string"
- },
- "queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
}
},
- "id": "SparkSqlJob",
- "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries."
+ "id": "SparkSqlJob"
},
"Cluster": {
"properties": {
@@ -411,8 +905,8 @@
"type": "string"
},
"clusterUuid": {
- "type": "string",
- "description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster."
+ "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.",
@@ -424,6 +918,7 @@
"type": "object"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -431,41 +926,40 @@
"type": "string"
},
"operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
- "type": "array",
- "description": "A list of operations that matches the specified filter in the request."
+ "type": "array"
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations."
+ "id": "ListOperationsResponse"
},
"SoftwareConfig": {
+ "description": "Specifies the selection and config of software inside the cluster.",
"type": "object",
"properties": {
"properties": {
+ "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.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"
+ "type": "string",
+ "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning)."
}
},
- "id": "SoftwareConfig",
- "description": "Specifies the selection and config of software inside the cluster."
+ "id": "SoftwareConfig"
},
"JobPlacement": {
"description": "Cloud Dataproc job config.",
"type": "object",
"properties": {
"clusterUuid": {
- "type": "string",
- "description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted."
+ "description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.",
+ "type": "string"
},
"clusterName": {
"description": "Required. The name of the cluster where the job will be submitted.",
@@ -475,22 +969,15 @@
"id": "JobPlacement"
},
"ClusterStatus": {
+ "id": "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"
+ "type": "string",
+ "description": "Output-only. Optional details of cluster's state."
},
"state": {
- "enum": [
- "UNKNOWN",
- "CREATING",
- "RUNNING",
- "ERROR",
- "DELETING",
- "UPDATING"
- ],
"description": "Output-only. The cluster's state.",
"type": "string",
"enumDescriptions": [
@@ -500,9 +987,19 @@
"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"
]
},
"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.",
@@ -512,33 +1009,39 @@
"UNSPECIFIED",
"UNHEALTHY",
"STALE_STATUS"
- ],
- "description": "Output-only. Additional state information that includes status reported by the agent.",
- "type": "string"
+ ]
},
"stateStartTime": {
"format": "google-datetime",
"description": "Output-only. Time when this state was entered.",
"type": "string"
}
- },
- "id": "ClusterStatus"
+ }
},
"PigJob": {
+ "id": "PigJob",
+ "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
"type": "object",
"properties": {
"continueOnFailure": {
- "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
- "type": "boolean"
+ "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"
+ "$ref": "QueryList",
+ "description": "A list of queries."
},
"queryFileUri": {
"description": "The HCFS URI of the script that contains the Pig queries.",
"type": "string"
},
+ "jarFileUris": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "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."
+ },
"scriptVariables": {
"type": "object",
"additionalProperties": {
@@ -546,16 +1049,9 @@
},
"description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value])."
},
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
},
"properties": {
"additionalProperties": {
@@ -564,17 +1060,15 @@
"description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
"type": "object"
}
- },
- "id": "PigJob",
- "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN."
+ }
},
"ListClustersResponse": {
"description": "The list of all clusters in a project.",
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "Output-only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest."
+ "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"
},
"clusters": {
"description": "Output-only. The clusters in the project.",
@@ -590,14 +1084,53 @@
"description": "A Cloud Dataproc job resource.",
"type": "object",
"properties": {
+ "reference": {
+ "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.",
+ "$ref": "JobReference"
+ },
+ "hadoopJob": {
+ "$ref": "HadoopJob",
+ "description": "Job is a Hadoop job."
+ },
+ "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"
+ },
+ "placement": {
+ "$ref": "JobPlacement",
+ "description": "Required. Job information, including how, when, and where to run the job."
+ },
+ "driverControlFilesUri": {
+ "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
+ "type": "string"
+ },
+ "scheduling": {
+ "$ref": "JobScheduling",
+ "description": "Optional. Job scheduling configuration."
+ },
+ "pigJob": {
+ "$ref": "PigJob",
+ "description": "Job is a Pig job."
+ },
+ "hiveJob": {
+ "$ref": "HiveJob",
+ "description": "Job is a Hive job."
+ },
+ "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"
+ },
"sparkJob": {
"$ref": "SparkJob",
"description": "Job is a Spark job."
},
- "sparkSqlJob": {
- "$ref": "SparkSqlJob",
- "description": "Job is a SparkSql job."
- },
"statusHistory": {
"description": "Output-only. The previous job status.",
"items": {
@@ -605,6 +1138,10 @@
},
"type": "array"
},
+ "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.",
"items": {
@@ -615,57 +1152,35 @@
"pysparkJob": {
"$ref": "PySparkJob",
"description": "Job is a Pyspark job."
- },
- "reference": {
- "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.",
- "$ref": "JobReference"
- },
- "hadoopJob": {
- "$ref": "HadoopJob",
- "description": "Job is a Hadoop job."
- },
- "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"
- },
- "scheduling": {
- "$ref": "JobScheduling",
- "description": "Optional. Job scheduling configuration."
- },
- "pigJob": {
- "description": "Job is a Pig job.",
- "$ref": "PigJob"
- },
- "hiveJob": {
- "$ref": "HiveJob",
- "description": "Job is a Hive job."
- },
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job."
- },
- "driverOutputResourceUri": {
- "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.",
- "type": "string"
}
},
"id": "Job"
},
"SparkJob": {
- "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
"type": "object",
"properties": {
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file that contains the main class.",
+ "type": "string"
+ },
+ "jarFileUris": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark 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 Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object"
+ },
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"items": {
@@ -674,11 +1189,11 @@
"type": "array"
},
"fileUris": {
+ "description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.",
"items": {
"type": "string"
},
- "type": "array",
- "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"
},
"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.",
@@ -690,39 +1205,16 @@
"type": "string"
},
"type": "array"
- },
- "mainJarFileUri": {
- "type": "string",
- "description": "The HCFS URI of the jar file that contains the main class."
- },
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
- },
- "properties": {
- "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"
}
},
- "id": "SparkJob"
+ "id": "SparkJob",
+ "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN."
},
"JobStatus": {
- "description": "Cloud Dataproc job status.",
- "type": "object",
"properties": {
"details": {
- "type": "string",
- "description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e."
+ "description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
+ "type": "string"
},
"state": {
"enumDescriptions": [
@@ -774,10 +1266,11 @@
"type": "string"
}
},
- "id": "JobStatus"
+ "id": "JobStatus",
+ "description": "Cloud Dataproc job status.",
+ "type": "object"
},
"ManagedGroupConfig": {
- "type": "object",
"properties": {
"instanceGroupManagerName": {
"description": "Output-only. The name of the Instance Group Manager for this group.",
@@ -789,13 +1282,16 @@
}
},
"id": "ManagedGroupConfig",
- "description": "Specifies the resources used to actively manage an instance group."
+ "description": "Specifies the resources used to actively manage an instance group.",
+ "type": "object"
},
"ClusterOperationStatus": {
+ "description": "The status of the operation.",
+ "type": "object",
"properties": {
"innerState": {
- "type": "string",
- "description": "Output-only. A message containing the detailed operation state."
+ "description": "Output-only. A message containing the detailed operation state.",
+ "type": "string"
},
"stateStartTime": {
"format": "google-datetime",
@@ -807,6 +1303,8 @@
"type": "string"
},
"state": {
+ "description": "Output-only. A message containing the operation state.",
+ "type": "string",
"enumDescriptions": [
"Unused.",
"The operation has been created.",
@@ -818,17 +1316,31 @@
"PENDING",
"RUNNING",
"DONE"
- ],
- "description": "Output-only. A message containing the operation state.",
- "type": "string"
+ ]
}
},
- "id": "ClusterOperationStatus",
- "description": "The status of the operation.",
- "type": "object"
+ "id": "ClusterOperationStatus"
},
"HadoopJob": {
"properties": {
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"mainJarFileUri": {
"description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
"type": "string"
@@ -841,8 +1353,8 @@
"type": "array"
},
"loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
},
"properties": {
"additionalProperties": {
@@ -857,51 +1369,26 @@
"type": "string"
},
"type": "array"
- },
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "mainClass": {
- "type": "string",
- "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris."
- },
- "archiveUris": {
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
}
},
"id": "HadoopJob",
"description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
"type": "object"
},
- "QueryList": {
- "description": "A list of queries to run on a cluster.",
- "type": "object",
- "properties": {
- "queries": {
- "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "QueryList"
- },
"YarnApplication": {
"description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
"type": "object",
"properties": {
+ "trackingUrl": {
+ "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
+ "type": "string"
+ },
+ "progress": {
+ "format": "float",
+ "description": "Required. The numerical progress of the application, from 1 to 100.",
+ "type": "number"
+ },
"state": {
- "description": "Required. The application state.",
- "type": "string",
"enumDescriptions": [
"Status is unspecified.",
"Status is NEW.",
@@ -923,24 +1410,31 @@
"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": {
- "format": "float",
- "description": "Required. The numerical progress of the application, from 1 to 100.",
- "type": "number"
}
},
"id": "YarnApplication"
},
+ "QueryList": {
+ "id": "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",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
+ },
"DiagnoseClusterRequest": {
"description": "A request to collect cluster diagnostic information.",
"type": "object",
@@ -968,27 +1462,19 @@
"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.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "Output-only. Errors encountered during operation execution."
},
"labels": {
+ "description": "Output-only. Labels associated with the operation",
"type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Output-only. Labels associated with the operation"
+ }
},
"status": {
"description": "Output-only. Current operation status.",
@@ -1008,27 +1494,20 @@
"clusterUuid": {
"description": "Output-only. Cluster UUID for the operation.",
"type": "string"
+ },
+ "operationType": {
+ "type": "string",
+ "description": "Output-only. The operation type."
+ },
+ "description": {
+ "description": "Output-only. Short description of operation.",
+ "type": "string"
}
},
"id": "ClusterOperationMetadata"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"HiveJob": {
- "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
- "type": "object",
"properties": {
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
- "type": "object"
- },
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
"items": {
@@ -1036,27 +1515,42 @@
},
"type": "array"
},
+ "scriptVariables": {
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"properties": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
- "type": "object"
+ "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."
},
"continueOnFailure": {
"description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
"type": "boolean"
},
"queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
+ "description": "A list of queries.",
+ "$ref": "QueryList"
},
"queryFileUri": {
"description": "The HCFS URI of the script that contains Hive queries.",
"type": "string"
}
},
- "id": "HiveJob"
+ "id": "HiveJob",
+ "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
+ "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"
},
"DiagnoseClusterResults": {
"description": "The location of diagnostic output.",
@@ -1093,37 +1587,28 @@
"type": "string"
},
"workerConfig": {
- "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.",
- "$ref": "InstanceGroupConfig"
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster."
},
"gceClusterConfig": {
"$ref": "GceClusterConfig",
"description": "Required. The shared Google Compute Engine config settings for all instances in a cluster."
},
"softwareConfig": {
- "description": "Optional. The config settings for software inside the cluster.",
- "$ref": "SoftwareConfig"
+ "$ref": "SoftwareConfig",
+ "description": "Optional. The config settings for software inside the cluster."
}
},
"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": {
- "properties": {
- "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
"args": {
+ "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"items": {
"type": "string"
},
- "type": "array",
- "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"
},
"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.",
@@ -1160,22 +1645,40 @@
"loggingConfig": {
"$ref": "LoggingConfig",
"description": "Optional. The runtime log config for job execution."
- }
- },
- "id": "PySparkJob"
- },
- "GceClusterConfig": {
- "properties": {
- "internalIpOnly": {
- "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
- "type": "boolean"
},
- "metadata": {
+ "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"
+ }
+ }
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "networkUri": {
+ "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault",
+ "type": "string"
+ },
+ "zoneUri": {
+ "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
},
- "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata))."
+ "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
+ "type": "object"
+ },
+ "internalIpOnly": {
+ "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
+ "type": "boolean"
},
"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",
@@ -1192,31 +1695,174 @@
"type": "array"
},
"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"
+ "description": "Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com",
+ "type": "string"
},
"subnetworkUri": {
"description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
"type": "string"
- },
- "networkUri": {
- "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).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault"
- },
- "zoneUri": {
- "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
- "type": "string"
}
},
"id": "GceClusterConfig",
- "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster."
+ },
+ "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": {
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "The YARN metrics."
+ },
+ "hdfsMetrics": {
+ "description": "The HDFS metrics.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "id": "ClusterMetrics"
+ },
+ "AcceleratorConfig": {
+ "properties": {
+ "acceleratorTypeUri": {
+ "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80",
+ "type": "string"
+ },
+ "acceleratorCount": {
+ "format": "int32",
+ "description": "The number of the accelerator cards of this type exposed to this instance.",
+ "type": "integer"
+ }
+ },
+ "id": "AcceleratorConfig",
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
"type": "object"
+ },
+ "LoggingConfig": {
+ "description": "The runtime logging config of the job.",
+ "type": "object",
+ "properties": {
+ "driverLogLevels": {
+ "additionalProperties": {
+ "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"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "Operation"
+ },
+ "JobReference": {
+ "description": "Encapsulates the full scoping used to reference a job.",
+ "type": "object",
+ "properties": {
+ "jobId": {
+ "description": "Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string"
+ }
+ },
+ "id": "JobReference"
+ },
+ "SubmitJobRequest": {
+ "description": "A request to submit a job.",
+ "type": "object",
+ "properties": {
+ "job": {
+ "description": "Required. The job resource.",
+ "$ref": "Job"
+ }
+ },
+ "id": "SubmitJobRequest"
+ },
+ "Status": {
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code."
+ },
+ "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"
}
},
"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://dataproc.googleapis.com/",
@@ -1229,661 +1875,15 @@
}
}
},
- "servicePath": "",
- "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
"kind": "discovery#restDescription",
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "servicePath": "",
"rootUrl": "https://dataproc.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "dataproc",
"batchPath": "batch",
- "revision": "20170816",
- "id": "dataproc:v1",
+ "revision": "20170822",
"documentationLink": "https://cloud.google.com/dataproc/",
- "title": "Google Cloud Dataproc API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "regions": {
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "httpMethod": "POST",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "dataproc.projects.regions.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED."
- },
- "delete": {
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "dataproc.projects.regions.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "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": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- }
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "id": "dataproc.projects.regions.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
- "path": "v1/{+name}",
- "id": "dataproc.projects.regions.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
- }
- }
- },
- "jobs": {
- "methods": {
- "cancel": {
- "request": {
- "$ref": "CancelJobRequest"
- },
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "description": "Required. The job ID.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to."
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.cancel",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"
- },
- "get": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "jobId": {
- "description": "Required. The job ID.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/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."
- },
- "patch": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
- "type": "string",
- "location": "query"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "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."
- },
- "submit": {
- "description": "Submits a job to a cluster.",
- "request": {
- "$ref": "SubmitJobRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "path": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit"
- },
- "delete": {
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.delete",
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "jobId": {
- "location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request."
- }
- }
- },
- "list": {
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Optional. The number of results to return in each response."
- },
- "region": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request."
- },
- "clusterName": {
- "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *"
- },
- "jobStateMatcher": {
- "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
- "type": "string",
- "location": "query",
- "enum": [
- "ALL",
- "ACTIVE",
- "NON_ACTIVE"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- }
- }
- },
- "clusters": {
- "methods": {
- "diagnose": {
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
- "request": {
- "$ref": "DiagnoseClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "clusterName": {
- "location": "path",
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "id": "dataproc.projects.regions.clusters.diagnose",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose"
- },
- "delete": {
- "description": "Deletes a cluster in a project.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "clusterName": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The cluster name."
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "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": {
- "id": "dataproc.projects.regions.clusters.list",
- "path": "v1/projects/{projectId}/regions/{region}/clusters",
- "description": "Lists all regions/{region}/clusters in a project.",
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Optional. The standard List page size.",
- "type": "integer",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true
- },
- "filter": {
- "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
- "type": "string",
- "location": "query"
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional. The standard List page token."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters"
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to."
- },
- "region": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.create",
- "path": "v1/projects/{projectId}/regions/{region}/clusters",
- "description": "Creates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- }
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterName": {
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "description": "Gets the resource representation for a cluster in a project.",
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Cluster"
- }
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "clusterName": {
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, only the following fields can be updated:\u003ctable\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003eMask\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003e\u003cstrong\u003ePurpose\u003c/strong\u003e\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003elabels\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eUpdate labels\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize primary worker group\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.secondary_worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize secondary worker group\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e",
- "type": "string",
- "location": "query"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "description": "Updates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- }
- }
- }
- }
- }
- }
- }
- }
- }
+ "id": "dataproc:v1"
}
diff --git a/dataproc/v1/dataproc-gen.go b/dataproc/v1/dataproc-gen.go
index 128a467..f700362 100644
--- a/dataproc/v1/dataproc-gen.go
+++ b/dataproc/v1/dataproc-gen.go
@@ -1623,7 +1623,7 @@
// mapred: mapred-site.xml
// pig: pig.properties
// spark: spark-defaults.conf
- // yarn: yarn-site.xml
+ // yarn: yarn-site.xmlFor more information, see Cluster properties.
Properties map[string]string `json:"properties,omitempty"`
// ForceSendFields is a list of field names (e.g. "ImageVersion") to
diff --git a/dataproc/v1beta2/dataproc-api.json b/dataproc/v1beta2/dataproc-api.json
index e4fd53e..0f2bbe5 100644
--- a/dataproc/v1beta2/dataproc-api.json
+++ b/dataproc/v1beta2/dataproc-api.json
@@ -1,6 +1,28 @@
{
- "ownerName": "Google",
+ "baseUrl": "https://dataproc.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://dataproc.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "dataproc",
+ "batchPath": "batch",
+ "id": "dataproc:v1beta2",
+ "documentationLink": "https://cloud.google.com/dataproc/",
+ "revision": "20170822",
+ "title": "Google Cloud Dataproc API",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"projects": {
@@ -9,28 +31,200 @@
"resources": {
"clusters": {
"methods": {
- "diagnose": {
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
- "request": {
- "$ref": "DiagnoseClusterRequest"
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListClustersResponse"
},
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. The standard List page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The standard List page size.",
+ "type": "integer"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.list",
+ "description": "Lists all regions/{region}/clusters in a project."
+ },
+ "create": {
"httpMethod": "POST",
"parameterOrder": [
"projectId",
- "region",
- "clusterName"
+ "region"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.create",
+ "description": "Creates a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ }
+ },
+ "patch": {
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.patch",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Updates a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "gracefulDecommissionTimeout": {
+ "location": "query",
+ "format": "google-duration",
+ "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterName": {
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "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": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
"location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true
},
"clusterName": {
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get"
+ },
+ "diagnose": {
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterName": {
"location": "path",
"description": "Required. The cluster name.",
"type": "string",
@@ -47,273 +241,51 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "id": "dataproc.projects.regions.clusters.diagnose"
+ "id": "dataproc.projects.regions.clusters.diagnose",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose"
},
"delete": {
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"id": "dataproc.projects.regions.clusters.delete",
"description": "Deletes a cluster in a project.",
"httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "clusterName": {
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}"
- },
- "list": {
- "id": "dataproc.projects.regions.clusters.list",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
- "description": "Lists all regions/{region}/clusters in a project.",
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Optional. The standard List page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The standard List page size.",
- "type": "integer",
- "location": "query"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "filter": {
- "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
- "type": "string",
- "location": "query"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters"
- },
- "create": {
- "id": "dataproc.projects.regions.clusters.create",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Creates a cluster in a project.",
"response": {
"$ref": "Operation"
},
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true,
"location": "path"
},
- "region": {
+ "clusterName": {
"location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string",
"required": true
}
},
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters"
- },
- "get": {
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterName": {
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "description": "Gets the resource representation for a cluster in a project."
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|",
- "type": "string",
- "location": "query"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterName": {
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "gracefulDecommissionTimeout": {
- "format": "google-duration",
- "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Updates a cluster in a project."
+ ]
}
}
},
"operations": {
"methods": {
- "cancel": {
- "id": "dataproc.projects.regions.operations.cancel",
- "path": "v1beta2/{+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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel"
- },
- "delete": {
- "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "id": "dataproc.projects.regions.operations.delete",
- "path": "v1beta2/{+name}"
- },
"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": {
@@ -340,179 +312,101 @@
"path": "v1beta2/{+name}"
},
"list": {
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations",
+ "id": "dataproc.projects.regions.operations.list",
+ "path": "v1beta2/{+name}",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "ListOperationsResponse"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true
- },
"pageSize": {
- "location": "query",
"format": "int32",
"description": "The standard list page size.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.operations.list"
- }
- }
- },
- "jobs": {
- "methods": {
+ ]
+ },
"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.",
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
+ "id": "dataproc.projects.regions.operations.cancel",
+ "path": "v1beta2/{+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.",
"response": {
- "$ref": "Job"
+ "$ref": "Empty"
},
"parameterOrder": [
- "projectId",
- "region",
- "jobId"
+ "name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "jobId": {
+ "name": {
"location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "description": "The name of the operation resource to be cancelled.",
"type": "string",
"required": true,
- "location": "path"
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
}
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.cancel",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "jobId": {
- "description": "Required. The job ID.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
- "type": "string",
- "location": "query"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.patch",
- "description": "Updates a job in a project.",
- "request": {
- "$ref": "Job"
}
},
- "get": {
- "description": "Gets the resource representation for a job in a project.",
- "response": {
- "$ref": "Job"
- },
+ "delete": {
+ "httpMethod": "DELETE",
"parameterOrder": [
- "projectId",
- "region",
- "jobId"
+ "name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "jobId": {
- "description": "Required. The job ID.",
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
"type": "string",
"required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"location": "path"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
}
},
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.get",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}"
- },
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "path": "v1beta2/{+name}",
+ "id": "dataproc.projects.regions.operations.delete",
+ "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED."
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
"submit": {
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit",
"request": {
"$ref": "SubmitJobRequest"
},
@@ -529,49 +423,49 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
"projectId": {
- "location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit"
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
+ "id": "dataproc.projects.regions.jobs.submit"
},
"delete": {
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.delete",
"description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
"httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"projectId",
"region",
"jobId"
],
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"region": {
- "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"jobId": {
- "location": "path",
"description": "Required. The job ID.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"projectId": {
"location": "path",
@@ -580,38 +474,49 @@
"required": true
}
},
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.delete"
},
"list": {
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
+ "id": "dataproc.projects.regions.jobs.list",
"description": "Lists regions/{region}/jobs in a project.",
"httpMethod": "GET",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
"parameterOrder": [
"projectId",
"region"
],
- "response": {
- "$ref": "ListJobsResponse"
- },
"parameters": {
- "filter": {
- "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
- "location": "query"
+ "required": true,
+ "location": "path"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
+ "type": "string"
},
"jobStateMatcher": {
+ "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
+ "type": "string",
+ "location": "query",
"enum": [
"ALL",
"ACTIVE",
"NON_ACTIVE"
- ],
- "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
- "type": "string",
- "location": "query"
+ ]
},
"pageToken": {
+ "location": "query",
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"format": "int32",
@@ -626,10 +531,85 @@
"location": "path"
},
"clusterName": {
+ "location": "query",
"description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "cancel": {
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.regions.jobs.cancel",
+ "request": {
+ "$ref": "CancelJobRequest"
+ },
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "jobId": {
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "patch": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
"type": "string",
"location": "query"
},
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true
+ },
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
@@ -640,9 +620,51 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
- "id": "dataproc.projects.regions.jobs.list"
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "description": "Updates a job in a project.",
+ "request": {
+ "$ref": "Job"
+ }
+ },
+ "get": {
+ "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": {
+ "jobId": {
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.get"
}
}
}
@@ -653,9 +675,9 @@
},
"parameters": {
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"location": "query",
@@ -664,19 +686,19 @@
"type": "boolean"
},
"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"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -684,41 +706,35 @@
"default": "true",
"type": "boolean"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "callback": {
- "description": "JSONP",
+ "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",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -726,17 +742,23 @@
],
"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.",
+ "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"
}
},
"schemas": {
@@ -744,21 +766,25 @@
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
"response": {
+ "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": {
- "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": {
@@ -767,10 +793,6 @@
},
"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"
@@ -795,8 +817,8 @@
"type": "object",
"properties": {
"job": {
- "description": "Required. The job resource.",
- "$ref": "Job"
+ "$ref": "Job",
+ "description": "Required. The job resource."
}
},
"id": "SubmitJobRequest"
@@ -805,6 +827,15 @@
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
@@ -815,35 +846,30 @@
"type": "object"
},
"type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
}
},
"id": "Status"
},
- "JobScheduling": {
- "description": "Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release.",
- "type": "object",
- "properties": {
- "maxFailuresPerHour": {
- "format": "int32",
- "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
- "type": "integer"
- }
- },
- "id": "JobScheduling"
- },
"InstanceGroupConfig": {
"description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
"type": "object",
"properties": {
+ "machineTypeUri": {
+ "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2",
+ "type": "string"
+ },
+ "imageUri": {
+ "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
+ "type": "string"
+ },
+ "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"
+ },
"instanceNames": {
"description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
"items": {
@@ -864,61 +890,57 @@
"type": "integer"
},
"diskConfig": {
- "description": "Optional. Disk option config settings.",
- "$ref": "DiskConfig"
- },
- "isPreemptible": {
- "description": "Optional. Specifies that this instance group contains preemptible instances.",
- "type": "boolean"
- },
- "managedGroupConfig": {
- "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.",
- "$ref": "ManagedGroupConfig"
- },
- "imageUri": {
- "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
- "type": "string"
- },
- "machineTypeUri": {
- "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2",
- "type": "string"
+ "$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": {
+ "format": "int32",
+ "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
+ "type": "integer"
+ }
+ },
+ "id": "JobScheduling"
+ },
"NodeInitializationAction": {
"description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
"type": "object",
"properties": {
+ "executableFile": {
+ "description": "Required. Google Cloud Storage URI of executable file.",
+ "type": "string"
+ },
"executionTimeout": {
"format": "google-duration",
"description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
"type": "string"
- },
- "executableFile": {
- "description": "Required. Google Cloud Storage URI of executable file.",
- "type": "string"
}
},
"id": "NodeInitializationAction"
},
"ListJobsResponse": {
+ "description": "A list of jobs in a project.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
- "type": "string"
- },
"jobs": {
"description": "Output-only. Jobs list.",
"items": {
"$ref": "Job"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
+ "type": "string"
}
},
- "id": "ListJobsResponse",
- "description": "A list of jobs in a project.",
- "type": "object"
+ "id": "ListJobsResponse"
},
"CancelJobRequest": {
"description": "A request to cancel a job.",
@@ -927,21 +949,23 @@
"id": "CancelJobRequest"
},
"SparkSqlJob": {
+ "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
+ "type": "object",
"properties": {
"queryFileUri": {
"description": "The HCFS URI of the script that contains SQL queries.",
"type": "string"
},
"queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
+ "$ref": "QueryList",
+ "description": "A list of queries."
},
"scriptVariables": {
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
- "type": "object"
+ }
},
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
@@ -951,37 +975,45 @@
"type": "array"
},
"loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
},
"properties": {
+ "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object"
+ }
}
},
- "id": "SparkSqlJob",
- "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
- "type": "object"
+ "id": "SparkSqlJob"
},
"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": {
+ "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.",
- "type": "object"
+ }
},
"metrics": {
- "$ref": "ClusterMetrics",
- "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release."
+ "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
+ "$ref": "ClusterMetrics"
},
"status": {
- "description": "Output-only. Cluster status.",
- "$ref": "ClusterStatus"
+ "$ref": "ClusterStatus",
+ "description": "Output-only. Cluster status."
+ },
+ "config": {
+ "$ref": "ClusterConfig",
+ "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
},
"statusHistory": {
"description": "Output-only. The previous cluster status.",
@@ -990,10 +1022,6 @@
},
"type": "array"
},
- "config": {
- "$ref": "ClusterConfig",
- "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
- },
"clusterUuid": {
"description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.",
"type": "string"
@@ -1001,51 +1029,45 @@
"clusterName": {
"description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
"type": "string"
- },
- "projectId": {
- "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
- "type": "string"
}
},
- "id": "Cluster",
- "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
- "type": "object"
+ "id": "Cluster"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"SoftwareConfig": {
+ "description": "Specifies the selection and config of software inside the cluster.",
+ "type": "object",
"properties": {
- "imageVersion": {
- "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
- "type": "string"
- },
"properties": {
"additionalProperties": {
"type": "string"
},
- "description": "Optional. The properties to set on daemon 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",
+ "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
"type": "object"
+ },
+ "imageVersion": {
+ "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
+ "type": "string"
}
},
- "id": "SoftwareConfig",
- "description": "Specifies the selection and config of software inside the cluster.",
- "type": "object"
+ "id": "SoftwareConfig"
},
"JobPlacement": {
"description": "Cloud Dataproc job config.",
@@ -1063,6 +1085,8 @@
"id": "JobPlacement"
},
"PigJob": {
+ "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
+ "type": "object",
"properties": {
"continueOnFailure": {
"description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
@@ -1073,8 +1097,15 @@
"type": "string"
},
"queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
+ "scriptVariables": {
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
},
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
@@ -1083,13 +1114,6 @@
},
"type": "array"
},
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
- "type": "object"
- },
"loggingConfig": {
"description": "Optional. The runtime log config for job execution.",
"$ref": "LoggingConfig"
@@ -1102,13 +1126,19 @@
"type": "object"
}
},
- "id": "PigJob",
- "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
- "type": "object"
+ "id": "PigJob"
},
"ClusterStatus": {
+ "description": "The status of a cluster and its instances.",
+ "type": "object",
"properties": {
+ "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.",
@@ -1124,9 +1154,7 @@
"ERROR",
"DELETING",
"UPDATING"
- ],
- "description": "Output-only. The cluster's state.",
- "type": "string"
+ ]
},
"substate": {
"enumDescriptions": [
@@ -1146,17 +1174,13 @@
"format": "google-datetime",
"description": "Output-only. Time when this state was entered.",
"type": "string"
- },
- "detail": {
- "description": "Output-only. Optional details of cluster's state.",
- "type": "string"
}
},
- "id": "ClusterStatus",
- "description": "The status of a cluster and its instances.",
- "type": "object"
+ "id": "ClusterStatus"
},
"ListClustersResponse": {
+ "description": "The list of all clusters in a project.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "Output-only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListClustersRequest\u003c/code\u003e.",
@@ -1170,14 +1194,103 @@
"type": "array"
}
},
- "id": "ListClustersResponse",
- "description": "The list of all clusters in a project.",
- "type": "object"
+ "id": "ListClustersResponse"
+ },
+ "Job": {
+ "description": "A Cloud Dataproc job resource.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "$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."
+ },
+ "driverControlFilesUri": {
+ "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
+ "type": "string"
+ },
+ "scheduling": {
+ "$ref": "JobScheduling",
+ "description": "Optional. Job scheduling configuration."
+ },
+ "pigJob": {
+ "$ref": "PigJob",
+ "description": "Job is a Pig job."
+ },
+ "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 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"
+ },
+ "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": {
+ "$ref": "SparkSqlJob",
+ "description": "Job is a SparkSql job."
+ },
+ "statusHistory": {
+ "description": "Output-only. The previous job status.",
+ "items": {
+ "$ref": "JobStatus"
+ },
+ "type": "array"
+ },
+ "yarnApplications": {
+ "description": "Output-only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
+ "items": {
+ "$ref": "YarnApplication"
+ },
+ "type": "array"
+ },
+ "pysparkJob": {
+ "description": "Job is a Pyspark job.",
+ "$ref": "PySparkJob"
+ }
+ },
+ "id": "Job"
},
"SparkJob": {
"description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) 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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file that contains the main class.",
+ "type": "string"
+ },
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
"items": {
@@ -1186,8 +1299,8 @@
"type": "array"
},
"loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
},
"properties": {
"additionalProperties": {
@@ -1209,124 +1322,14 @@
"type": "string"
},
"type": "array"
- },
- "mainClass": {
- "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file that contains the main class.",
- "type": "string"
}
},
"id": "SparkJob"
},
- "Job": {
- "properties": {
- "hadoopJob": {
- "$ref": "HadoopJob",
- "description": "Job is a Hadoop job."
- },
- "placement": {
- "$ref": "JobPlacement",
- "description": "Required. Job information, including how, when, and where to run the job."
- },
- "status": {
- "$ref": "JobStatus",
- "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields."
- },
- "driverControlFilesUri": {
- "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
- "type": "string"
- },
- "scheduling": {
- "$ref": "JobScheduling",
- "description": "Optional. Job scheduling configuration."
- },
- "pigJob": {
- "$ref": "PigJob",
- "description": "Job is a Pig job."
- },
- "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"
- },
- "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.",
- "items": {
- "$ref": "JobStatus"
- },
- "type": "array"
- },
- "sparkSqlJob": {
- "$ref": "SparkSqlJob",
- "description": "Job is a SparkSql job."
- },
- "sparkJob": {
- "description": "Job is a Spark job.",
- "$ref": "SparkJob"
- },
- "yarnApplications": {
- "description": "Output-only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "items": {
- "$ref": "YarnApplication"
- },
- "type": "array"
- },
- "pysparkJob": {
- "description": "Job is a Pyspark job.",
- "$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"
- }
- },
- "id": "Job",
- "description": "A Cloud Dataproc job resource.",
- "type": "object"
- },
"JobStatus": {
+ "description": "Cloud Dataproc job status.",
+ "type": "object",
"properties": {
- "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"
- },
- "stateStartTime": {
- "format": "google-datetime",
- "description": "Output-only. The time when this state was entered.",
- "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"
@@ -1358,11 +1361,52 @@
],
"description": "Output-only. A state message specifying the overall job state.",
"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"
+ ]
+ },
+ "stateStartTime": {
+ "format": "google-datetime",
+ "description": "Output-only. The time when this state was entered.",
+ "type": "string"
}
},
- "id": "JobStatus",
- "description": "Cloud Dataproc job status.",
- "type": "object"
+ "id": "JobStatus"
+ },
+ "LifecycleConfig": {
+ "description": "Specifies the cluster auto delete related schedule configuration.",
+ "type": "object",
+ "properties": {
+ "autoDeleteTtl": {
+ "format": "google-duration",
+ "description": "Optional. The life duration of cluster, the cluster will be auto-deleted at the end of this duration.",
+ "type": "string"
+ },
+ "autoDeleteTime": {
+ "format": "google-datetime",
+ "description": "Optional. The time when cluster will be auto-deleted.",
+ "type": "string"
+ },
+ "idleDeleteTtl": {
+ "format": "google-duration",
+ "description": "Optional. The longest duration that cluster would keep alive while staying idle; passing this threshold will cause cluster to be auto-deleted.",
+ "type": "string"
+ }
+ },
+ "id": "LifecycleConfig"
},
"ManagedGroupConfig": {
"description": "Specifies the resources used to actively manage an instance group.",
@@ -1383,26 +1427,6 @@
"description": "The status of the operation.",
"type": "object",
"properties": {
- "details": {
- "description": "Output-only.A message containing any operation metadata details.",
- "type": "string"
- },
- "state": {
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ],
- "description": "Output-only. A message containing the operation state.",
- "type": "string",
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ]
- },
"innerState": {
"description": "Output-only. A message containing the detailed operation state.",
"type": "string"
@@ -1411,27 +1435,94 @@
"format": "google-datetime",
"description": "Output-only. The time this state was entered.",
"type": "string"
+ },
+ "details": {
+ "description": "Output-only.A message containing any operation metadata details.",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
+ ],
+ "description": "Output-only. A message containing the operation state.",
+ "type": "string"
}
},
"id": "ClusterOperationStatus"
},
- "HadoopJob": {
+ "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": {
- "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.",
+ "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"
},
- "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.",
+ "progress": {
+ "format": "float",
+ "description": "Required. The numerical progress of the application, from 1 to 100.",
+ "type": "number"
+ },
+ "state": {
+ "enumDescriptions": [
+ "Status is unspecified.",
+ "Status is NEW.",
+ "Status is NEW_SAVING.",
+ "Status is SUBMITTED.",
+ "Status is ACCEPTED.",
+ "Status is RUNNING.",
+ "Status is FINISHED.",
+ "Status is FAILED.",
+ "Status is KILLED."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "NEW",
+ "NEW_SAVING",
+ "SUBMITTED",
+ "ACCEPTED",
+ "RUNNING",
+ "FINISHED",
+ "FAILED",
+ "KILLED"
+ ],
+ "description": "Required. The application state.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The application name.",
+ "type": "string"
+ }
+ },
+ "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",
"items": {
"type": "string"
},
"type": "array"
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
- "type": "string"
- },
+ }
+ },
+ "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": {
"jarFileUris": {
"description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
"items": {
@@ -1463,71 +1554,24 @@
"type": "string"
},
"type": "array"
- }
- },
- "id": "HadoopJob",
- "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
- "type": "object"
- },
- "QueryList": {
- "properties": {
- "queries": {
- "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
+ },
+ "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.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
+ "type": "string"
}
},
- "id": "QueryList",
- "description": "A list of queries to run on a cluster.",
- "type": "object"
- },
- "YarnApplication": {
- "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "type": "object",
- "properties": {
- "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": {
- "format": "float",
- "description": "Required. The numerical progress of the application, from 1 to 100.",
- "type": "number"
- }
- },
- "id": "YarnApplication"
+ "id": "HadoopJob"
},
"DiagnoseClusterRequest": {
"description": "A request to collect cluster diagnostic information.",
@@ -1539,21 +1583,31 @@
"description": "Specifies the config of disk options for a group of VM instances.",
"type": "object",
"properties": {
- "numLocalSsds": {
- "format": "int32",
- "description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.",
- "type": "integer"
- },
"bootDiskSizeGb": {
"format": "int32",
"description": "Optional. Size in GB of the boot disk (default is 500GB).",
"type": "integer"
+ },
+ "numLocalSsds": {
+ "format": "int32",
+ "description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.",
+ "type": "integer"
}
},
"id": "DiskConfig"
},
"ClusterOperationMetadata": {
+ "description": "Metadata describing the operation.",
+ "type": "object",
"properties": {
+ "operationType": {
+ "description": "Output-only. The operation type.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Output-only. Short description of operation.",
+ "type": "string"
+ },
"warnings": {
"description": "Output-only. Errors encountered during operation execution.",
"items": {
@@ -1579,37 +1633,33 @@
},
"type": "array"
},
- "clusterName": {
- "description": "Output-only. Name of the cluster for the operation.",
- "type": "string"
- },
"clusterUuid": {
"description": "Output-only. Cluster UUID for the operation.",
"type": "string"
},
- "operationType": {
- "description": "Output-only. The operation type.",
- "type": "string"
- },
- "description": {
- "description": "Output-only. Short description of operation.",
+ "clusterName": {
+ "description": "Output-only. Name of the cluster for the operation.",
"type": "string"
}
},
- "id": "ClusterOperationMetadata",
- "description": "Metadata describing the operation.",
- "type": "object"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "id": "ClusterOperationMetadata"
},
"HiveJob": {
"description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
"type": "object",
"properties": {
+ "continueOnFailure": {
+ "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
+ "type": "boolean"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains Hive queries.",
+ "type": "string"
+ },
+ "queryList": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ },
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
"items": {
@@ -1618,11 +1668,11 @@
"type": "array"
},
"scriptVariables": {
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
- "type": "object"
+ }
},
"properties": {
"additionalProperties": {
@@ -1630,43 +1680,31 @@
},
"description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
"type": "object"
- },
- "continueOnFailure": {
- "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
- "type": "boolean"
- },
- "queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains Hive queries.",
- "type": "string"
}
},
"id": "HiveJob"
},
+ "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": {
"description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.",
"type": "string"
}
},
- "id": "DiagnoseClusterResults",
- "description": "The location of diagnostic output.",
- "type": "object"
+ "id": "DiagnoseClusterResults"
},
"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": {
- "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster.",
- "$ref": "InstanceGroupConfig"
- },
"initializationActions": {
"description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's \u003ccode\u003erole\u003c/code\u003e metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
"items": {
@@ -1674,6 +1712,10 @@
},
"type": "array"
},
+ "lifecycleConfig": {
+ "description": "Optional. The config setting for auto delete cluster schedule.",
+ "$ref": "LifecycleConfig"
+ },
"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"
@@ -1683,17 +1725,23 @@
"$ref": "InstanceGroupConfig"
},
"gceClusterConfig": {
- "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.",
- "$ref": "GceClusterConfig"
+ "$ref": "GceClusterConfig",
+ "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster."
},
"softwareConfig": {
"$ref": "SoftwareConfig",
"description": "Optional. The config settings for software inside the cluster."
+ },
+ "masterConfig": {
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster."
+ },
+ "secondaryWorkerConfig": {
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster."
}
},
- "id": "ClusterConfig",
- "description": "The cluster config.",
- "type": "object"
+ "id": "ClusterConfig"
},
"PySparkJob": {
"description": "A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.",
@@ -1711,11 +1759,11 @@
"$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"
- },
- "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.",
@@ -1756,6 +1804,14 @@
"description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
"type": "object",
"properties": {
+ "networkUri": {
+ "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault",
+ "type": "string"
+ },
+ "zoneUri": {
+ "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
+ "type": "string"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -1788,28 +1844,14 @@
"subnetworkUri": {
"description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
"type": "string"
- },
- "networkUri": {
- "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault",
- "type": "string"
- },
- "zoneUri": {
- "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
- "type": "string"
}
},
"id": "GceClusterConfig"
},
"ClusterMetrics": {
+ "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
+ "type": "object",
"properties": {
- "yarnMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The YARN metrics.",
- "type": "object"
- },
"hdfsMetrics": {
"additionalProperties": {
"format": "int64",
@@ -1817,13 +1859,21 @@
},
"description": "The HDFS metrics.",
"type": "object"
+ },
+ "yarnMetrics": {
+ "description": "The YARN metrics.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
}
},
- "id": "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"
+ "id": "ClusterMetrics"
},
"AcceleratorConfig": {
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
+ "type": "object",
"properties": {
"acceleratorTypeUri": {
"description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80",
@@ -1835,14 +1885,15 @@
"type": "integer"
}
},
- "id": "AcceleratorConfig",
- "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
- "type": "object"
+ "id": "AcceleratorConfig"
},
"LoggingConfig": {
+ "description": "The runtime logging config of the job.",
+ "type": "object",
"properties": {
"driverLogLevels": {
"additionalProperties": {
+ "type": "string",
"enum": [
"LEVEL_UNSPECIFIED",
"ALL",
@@ -1853,44 +1904,19 @@
"ERROR",
"FATAL",
"OFF"
- ],
- "type": "string"
+ ]
},
"description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
"type": "object"
}
},
- "id": "LoggingConfig",
- "description": "The runtime logging config of the job.",
- "type": "object"
+ "id": "LoggingConfig"
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
- "version": "v1beta2",
- "baseUrl": "https://dataproc.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "servicePath": "",
- "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
- "rootUrl": "https://dataproc.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "dataproc",
- "batchPath": "batch",
- "id": "dataproc:v1beta2",
- "documentationLink": "https://cloud.google.com/dataproc/",
- "revision": "20170816",
- "title": "Google Cloud Dataproc API"
+ "version": "v1beta2"
}
diff --git a/dataproc/v1beta2/dataproc-gen.go b/dataproc/v1beta2/dataproc-gen.go
index 3550c6e..78b4634 100644
--- a/dataproc/v1beta2/dataproc-gen.go
+++ b/dataproc/v1beta2/dataproc-gen.go
@@ -272,6 +272,10 @@
//
InitializationActions []*NodeInitializationAction `json:"initializationActions,omitempty"`
+ // LifecycleConfig: Optional. The config setting for auto delete cluster
+ // schedule.
+ LifecycleConfig *LifecycleConfig `json:"lifecycleConfig,omitempty"`
+
// MasterConfig: Optional. The Google Compute Engine config settings for
// the master instance in a cluster.
MasterConfig *InstanceGroupConfig `json:"masterConfig,omitempty"`
@@ -1162,6 +1166,45 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// LifecycleConfig: Specifies the cluster auto delete related schedule
+// configuration.
+type LifecycleConfig struct {
+ // AutoDeleteTime: Optional. The time when cluster will be auto-deleted.
+ AutoDeleteTime string `json:"autoDeleteTime,omitempty"`
+
+ // AutoDeleteTtl: Optional. The life duration of cluster, the cluster
+ // will be auto-deleted at the end of this duration.
+ AutoDeleteTtl string `json:"autoDeleteTtl,omitempty"`
+
+ // IdleDeleteTtl: Optional. The longest duration that cluster would keep
+ // alive while staying idle; passing this threshold will cause cluster
+ // to be auto-deleted.
+ IdleDeleteTtl string `json:"idleDeleteTtl,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AutoDeleteTime") 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. "AutoDeleteTime") 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 *LifecycleConfig) MarshalJSON() ([]byte, error) {
+ type noMethod LifecycleConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// ListClustersResponse: The list of all clusters in a project.
type ListClustersResponse struct {
// Clusters: Output-only. The clusters in the project.
@@ -1623,7 +1666,7 @@
// mapred: mapred-site.xml
// pig: pig.properties
// spark: spark-defaults.conf
- // yarn: yarn-site.xml
+ // yarn: yarn-site.xmlFor more information, see Cluster properties.
Properties map[string]string `json:"properties,omitempty"`
// ForceSendFields is a list of field names (e.g. "ImageVersion") to
diff --git a/datastore/v1/datastore-api.json b/datastore/v1/datastore-api.json
index 9f70bc3..92e272c 100644
--- a/datastore/v1/datastore-api.json
+++ b/datastore/v1/datastore-api.json
@@ -1,37 +1,120 @@
{
- "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"
- }
- }
- }
- },
- "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "rootUrl": "https://datastore.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "datastore",
- "batchPath": "batch",
- "id": "datastore:v1",
- "documentationLink": "https://cloud.google.com/datastore/",
- "revision": "20170815",
- "title": "Google Cloud Datastore API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "version_module": true,
"resources": {
"projects": {
"methods": {
+ "allocateIds": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "AllocateIdsResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1/projects/{projectId}:allocateIds",
+ "path": "v1/projects/{projectId}:allocateIds",
+ "id": "datastore.projects.allocateIds",
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
+ "request": {
+ "$ref": "AllocateIdsRequest"
+ }
+ },
+ "beginTransaction": {
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
+ "description": "Begins a new transaction.",
+ "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.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}:beginTransaction",
+ "id": "datastore.projects.beginTransaction",
+ "path": "v1/projects/{projectId}:beginTransaction"
+ },
+ "commit": {
+ "path": "v1/projects/{projectId}:commit",
+ "id": "datastore.projects.commit",
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
+ "request": {
+ "$ref": "CommitRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1/projects/{projectId}:commit"
+ },
+ "runQuery": {
+ "path": "v1/projects/{projectId}:runQuery",
+ "id": "datastore.projects.runQuery",
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
+ "description": "Queries for entities.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "RunQueryResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}:runQuery"
+ },
"rollback": {
- "path": "v1/projects/{projectId}:rollback",
- "id": "datastore.projects.rollback",
"description": "Rolls back a transaction.",
"request": {
"$ref": "RollbackRequest"
@@ -55,123 +138,17 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1/projects/{projectId}:rollback"
- },
- "runQuery": {
- "description": "Queries for entities.",
- "request": {
- "$ref": "RunQueryRequest"
- },
- "response": {
- "$ref": "RunQueryResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the project against which to make the request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectId}:runQuery",
- "id": "datastore.projects.runQuery",
- "path": "v1/projects/{projectId}:runQuery"
+ "flatPath": "v1/projects/{projectId}:rollback",
+ "path": "v1/projects/{projectId}:rollback",
+ "id": "datastore.projects.rollback"
},
"lookup": {
- "response": {
- "$ref": "LookupResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}:lookup",
- "id": "datastore.projects.lookup",
- "path": "v1/projects/{projectId}:lookup",
+ "description": "Looks up entities by key.",
"request": {
"$ref": "LookupRequest"
},
- "description": "Looks up entities by key."
- },
- "allocateIds": {
"response": {
- "$ref": "AllocateIdsResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}:allocateIds",
- "id": "datastore.projects.allocateIds",
- "path": "v1/projects/{projectId}:allocateIds",
- "request": {
- "$ref": "AllocateIdsRequest"
- },
- "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted."
- },
- "commit": {
- "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
- "request": {
- "$ref": "CommitRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "CommitResponse"
- },
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectId}:commit",
- "path": "v1/projects/{projectId}:commit",
- "id": "datastore.projects.commit"
- },
- "beginTransaction": {
- "response": {
- "$ref": "BeginTransactionResponse"
+ "$ref": "LookupResponse"
},
"parameterOrder": [
"projectId"
@@ -189,13 +166,9 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1/projects/{projectId}:beginTransaction",
- "id": "datastore.projects.beginTransaction",
- "path": "v1/projects/{projectId}:beginTransaction",
- "description": "Begins a new transaction.",
- "request": {
- "$ref": "BeginTransactionRequest"
- }
+ "flatPath": "v1/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup",
+ "path": "v1/projects/{projectId}:lookup"
}
},
"resources": {
@@ -215,11 +188,11 @@
],
"parameters": {
"name": {
- "location": "path",
"description": "The name of the operation resource to be cancelled.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/operations/[^/]+$"
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
@@ -228,35 +201,32 @@
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
},
"delete": {
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/operations/[^/]+$"
- }
- },
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ "id": "datastore.projects.operations.delete",
"path": "v1/{+name}",
- "id": "datastore.projects.operations.delete"
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
},
"get": {
- "id": "datastore.projects.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"response": {
"$ref": "GoogleLongrunningOperation"
},
@@ -270,18 +240,19 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
"description": "The name of the operation resource.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path"
+ "required": true
}
},
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}"
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ "id": "datastore.projects.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
},
"list": {
- "id": "datastore.projects.operations.list",
- "path": "v1/{+name}/operations",
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
@@ -291,35 +262,37 @@
],
"httpMethod": "GET",
"parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
},
"name": {
- "location": "path",
"description": "The name of the operation's parent resource.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$"
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "The standard list page size.",
"type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1/projects/{projectsId}/operations"
+ "flatPath": "v1/projects/{projectsId}/operations",
+ "id": "datastore.projects.operations.list",
+ "path": "v1/{+name}/operations"
}
}
}
@@ -327,6 +300,71 @@
}
},
"parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "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.",
@@ -338,341 +376,63 @@
"type": "boolean",
"location": "query"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
- "upload_protocol": {
+ "oauth_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
- },
- "alt": {
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ]
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
}
},
"schemas": {
- "GoogleDatastoreAdminV1beta1CommonMetadata": {
- "type": "object",
- "properties": {
- "endTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The time the operation ended, either successfully or otherwise."
- },
- "state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "INITIALIZING",
- "PROCESSING",
- "CANCELLING",
- "FINALIZING",
- "SUCCESSFUL",
- "FAILED",
- "CANCELLED"
- ],
- "description": "The current state of the Operation.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Request is being prepared for processing.",
- "Request is actively being processed.",
- "Request is in the process of being cancelled after user called\nlongrunning.Operations.CancelOperation on the operation.",
- "Request has been processed and is in its finalization stage.",
- "Request has completed successfully.",
- "Request has finished being processed, but encountered an error.",
- "Request has finished being cancelled after user called\nlongrunning.Operations.CancelOperation."
- ]
- },
- "operationType": {
- "enumDescriptions": [
- "Unspecified.",
- "ExportEntities.",
- "ImportEntities.",
- "Build an index.",
- "Clear an index."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "EXPORT_ENTITIES",
- "IMPORT_ENTITIES",
- "BUILD_INDEX",
- "CLEAR_INDEX"
- ],
- "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
- "type": "string"
- },
- "startTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The time that work began on the operation."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
- "type": "object"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- },
- "Projection": {
- "properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
- }
- },
- "id": "Projection",
- "description": "A representation of a property in a projection.",
- "type": "object"
- },
- "ArrayValue": {
- "id": "ArrayValue",
- "description": "An array value.",
- "type": "object",
- "properties": {
- "values": {
- "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
- "items": {
- "$ref": "Value"
- },
- "type": "array"
- }
- }
- },
- "Mutation": {
- "description": "A mutation to apply to an entity.",
- "type": "object",
- "properties": {
- "delete": {
- "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.",
- "$ref": "Key"
- },
- "baseVersion": {
- "format": "int64",
- "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
- "type": "string"
- },
- "insert": {
- "$ref": "Entity",
- "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
- },
- "update": {
- "$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."
- }
- },
- "id": "Mutation"
- },
- "ReadOptions": {
- "id": "ReadOptions",
- "description": "The options shared by read requests.",
- "type": "object",
- "properties": {
- "transaction": {
- "format": "byte",
- "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "type": "string"
- },
- "readConsistency": {
- "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"
- }
- }
- },
- "RollbackResponse": {
- "properties": {},
- "id": "RollbackResponse",
- "description": "The response for Datastore.Rollback.\n(an empty message).",
- "type": "object"
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
- "type": "object",
- "properties": {
- "outputUrl": {
- "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
- "type": "string"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse",
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities."
- },
- "MutationResult": {
- "id": "MutationResult",
- "description": "The result of applying a mutation.",
- "type": "object",
- "properties": {
- "version": {
- "format": "int64",
- "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
- "type": "string"
- },
- "conflictDetected": {
- "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
- "type": "boolean"
- },
- "key": {
- "description": "The automatically allocated key.\nSet only when the mutation allocated a key.",
- "$ref": "Key"
- }
- }
- },
- "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"
- },
- "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.",
- "items": {
- "$ref": "GqlQueryParameter"
- },
- "type": "array"
- },
- "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"
- },
- "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"
- }
- },
- "id": "GqlQuery"
- },
"Filter": {
"description": "A holder for any type of filter.",
"type": "object",
"properties": {
- "compositeFilter": {
- "$ref": "CompositeFilter",
- "description": "A composite filter."
- },
"propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
+ "description": "A filter on a property.",
+ "$ref": "PropertyFilter"
+ },
+ "compositeFilter": {
+ "description": "A composite filter.",
+ "$ref": "CompositeFilter"
}
},
"id": "Filter"
},
"RunQueryRequest": {
- "id": "RunQueryRequest",
"description": "The request for Datastore.RunQuery.",
"type": "object",
"properties": {
+ "gqlQuery": {
+ "description": "The GQL query to run.",
+ "$ref": "GqlQuery"
+ },
+ "partitionId": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID."
+ },
+ "readOptions": {
+ "description": "The options for this query.",
+ "$ref": "ReadOptions"
+ },
"query": {
"$ref": "Query",
"description": "The query to run."
- },
- "gqlQuery": {
- "$ref": "GqlQuery",
- "description": "The GQL query to run."
- },
- "partitionId": {
- "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID.",
- "$ref": "PartitionId"
- },
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this query."
}
- }
+ },
+ "id": "RunQueryRequest"
},
"Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ "id": "Empty"
},
"RollbackRequest": {
- "description": "The request for Datastore.Rollback.",
- "type": "object",
"properties": {
"transaction": {
"format": "byte",
@@ -680,12 +440,16 @@
"type": "string"
}
},
- "id": "RollbackRequest"
+ "id": "RollbackRequest",
+ "description": "The request for Datastore.Rollback.",
+ "type": "object"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
- "description": "Metadata for ExportEntities operations.",
- "type": "object",
"properties": {
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ },
"progressBytes": {
"description": "An estimate of the number of bytes processed.",
"$ref": "GoogleDatastoreAdminV1beta1Progress"
@@ -699,18 +463,15 @@
"description": "Description of which entities are being exported."
},
"progressEntities": {
- "description": "An estimate of the number of entities processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
- },
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of entities processed."
}
},
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata",
+ "description": "Metadata for ExportEntities operations.",
+ "type": "object"
},
"TransactionOptions": {
- "id": "TransactionOptions",
"description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.",
"type": "object",
"properties": {
@@ -719,14 +480,23 @@
"description": "The transaction should only allow reads."
},
"readWrite": {
- "$ref": "ReadWrite",
- "description": "The transaction should allow both reads and writes."
+ "description": "The transaction should allow both reads and writes.",
+ "$ref": "ReadWrite"
}
- }
+ },
+ "id": "TransactionOptions"
},
"CompositeFilter": {
+ "description": "A filter that merges multiple other filters using the given operator.",
"type": "object",
"properties": {
+ "filters": {
+ "description": "The list of filters to combine.\nMust contain at least one filter.",
+ "items": {
+ "$ref": "Filter"
+ },
+ "type": "array"
+ },
"op": {
"enum": [
"OPERATOR_UNSPECIFIED",
@@ -738,20 +508,18 @@
"Unspecified. This value must not be used.",
"The results are required to satisfy each of the combined filters."
]
- },
- "filters": {
- "description": "The list of filters to combine.\nMust contain at least one filter.",
- "items": {
- "$ref": "Filter"
- },
- "type": "array"
}
},
- "id": "CompositeFilter",
- "description": "A filter that merges multiple other filters using the given operator."
+ "id": "CompositeFilter"
},
"GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
+ "description": "Metadata for ImportEntities operations.",
+ "type": "object",
"properties": {
+ "progressEntities": {
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of entities processed."
+ },
"common": {
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations."
@@ -765,20 +533,13 @@
"description": "An estimate of the number of bytes processed."
},
"entityFilter": {
- "description": "Description of which entities are being imported.",
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Description of which entities are being imported."
}
},
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
- "description": "Metadata for ImportEntities operations.",
- "type": "object"
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
},
"AllocateIdsResponse": {
- "id": "AllocateIdsResponse",
"description": "The response for Datastore.AllocateIds.",
"type": "object",
"properties": {
@@ -789,47 +550,19 @@
},
"type": "array"
}
- }
+ },
+ "id": "AllocateIdsResponse"
},
"Query": {
+ "description": "A query for entities.",
+ "type": "object",
"properties": {
- "projection": {
- "description": "The projection to return. Defaults to returning all properties.",
- "items": {
- "$ref": "Projection"
- },
- "type": "array"
- },
- "endCursor": {
- "format": "byte",
- "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "type": "string"
- },
- "limit": {
- "type": "integer",
- "format": "int32",
- "description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be \u003e= 0 if specified."
- },
- "filter": {
- "$ref": "Filter",
- "description": "The filter to apply."
- },
- "offset": {
- "format": "int32",
- "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.",
- "type": "integer"
- },
- "startCursor": {
- "format": "byte",
- "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "type": "string"
- },
"kind": {
+ "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.",
"items": {
"$ref": "KindExpression"
},
- "type": "array",
- "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified."
+ "type": "array"
},
"distinctOn": {
"description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
@@ -844,19 +577,45 @@
"$ref": "PropertyOrder"
},
"type": "array"
+ },
+ "projection": {
+ "description": "The projection to return. Defaults to returning all properties.",
+ "items": {
+ "$ref": "Projection"
+ },
+ "type": "array"
+ },
+ "endCursor": {
+ "format": "byte",
+ "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "type": "string"
+ },
+ "filter": {
+ "description": "The filter to apply.",
+ "$ref": "Filter"
+ },
+ "limit": {
+ "format": "int32",
+ "description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be \u003e= 0 if specified.",
+ "type": "integer"
+ },
+ "offset": {
+ "format": "int32",
+ "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.",
+ "type": "integer"
+ },
+ "startCursor": {
+ "format": "byte",
+ "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "type": "string"
}
},
- "id": "Query",
- "description": "A query for entities.",
- "type": "object"
+ "id": "Query"
},
"GoogleLongrunningOperation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -870,8 +629,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": {
@@ -880,28 +639,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"
}
},
- "id": "GoogleLongrunningOperation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
+ "id": "GoogleLongrunningOperation"
},
"ReadOnly": {
+ "properties": {},
"id": "ReadOnly",
"description": "Options specific to read-only transactions.",
- "type": "object",
- "properties": {}
+ "type": "object"
},
"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": {
- "description": "The operator to filter by.",
- "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Less than.",
@@ -919,16 +681,18 @@
"GREATER_THAN_OR_EQUAL",
"EQUAL",
"HAS_ANCESTOR"
- ]
- },
- "value": {
- "$ref": "Value",
- "description": "The value to compare the property to."
+ ],
+ "description": "The operator to filter by.",
+ "type": "string"
}
},
- "id": "PropertyFilter"
+ "id": "PropertyFilter",
+ "description": "A filter on a specific property.",
+ "type": "object"
},
"EntityResult": {
+ "description": "The result of fetching an entity from Datastore.",
+ "type": "object",
"properties": {
"cursor": {
"format": "byte",
@@ -941,22 +705,14 @@
"type": "string"
},
"entity": {
- "description": "The resulting entity.",
- "$ref": "Entity"
+ "$ref": "Entity",
+ "description": "The resulting entity."
}
},
- "id": "EntityResult",
- "description": "The result of fetching an entity from Datastore.",
- "type": "object"
+ "id": "EntityResult"
},
"Value": {
- "description": "A message that can hold any of the supported value types and associated\nmetadata.",
- "type": "object",
"properties": {
- "geoPointValue": {
- "$ref": "LatLng",
- "description": "A geo point value representing a point on the surface of Earth."
- },
"keyValue": {
"$ref": "Key",
"description": "A key value."
@@ -985,14 +741,14 @@
"type": "string"
},
"nullValue": {
- "enumDescriptions": [
- "Null value."
- ],
"enum": [
"NULL_VALUE"
],
"description": "A null value.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Null value."
+ ]
},
"booleanValue": {
"description": "A boolean value.",
@@ -1015,25 +771,31 @@
"entityValue": {
"description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.",
"$ref": "Entity"
+ },
+ "geoPointValue": {
+ "$ref": "LatLng",
+ "description": "A geo point value representing a point on the surface of Earth."
}
},
- "id": "Value"
+ "id": "Value",
+ "description": "A message that can hold any of the supported value types and associated\nmetadata.",
+ "type": "object"
},
"CommitResponse": {
"description": "The response for Datastore.Commit.",
"type": "object",
"properties": {
- "indexUpdates": {
- "type": "integer",
- "format": "int32",
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated."
- },
"mutationResults": {
"description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
"items": {
"$ref": "MutationResult"
},
"type": "array"
+ },
+ "indexUpdates": {
+ "format": "int32",
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ "type": "integer"
}
},
"id": "CommitResponse"
@@ -1042,13 +804,13 @@
"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": {
- "type": "string",
- "description": "If not empty, the ID of the namespace to which the entities belong."
- },
"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"
@@ -1057,39 +819,37 @@
"description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.",
"type": "object",
"properties": {
- "key": {
- "$ref": "Key",
- "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key."
- },
"properties": {
"additionalProperties": {
"$ref": "Value"
},
"description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
"type": "object"
+ },
+ "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"
},
"ReadWrite": {
- "description": "Options specific to read / write transactions.",
- "type": "object",
"properties": {
"previousTransaction": {
- "type": "string",
"format": "byte",
- "description": "The transaction identifier of the transaction being retried."
+ "description": "The transaction identifier of the transaction being retried.",
+ "type": "string"
}
},
- "id": "ReadWrite"
+ "id": "ReadWrite",
+ "description": "Options specific to read / write transactions.",
+ "type": "object"
},
"LookupRequest": {
- "description": "The request for Datastore.Lookup.",
- "type": "object",
"properties": {
"readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this lookup request."
+ "description": "The options for this lookup request.",
+ "$ref": "ReadOptions"
},
"keys": {
"description": "Keys of entities to look up.",
@@ -1099,22 +859,13 @@
"type": "array"
}
},
- "id": "LookupRequest"
+ "id": "LookupRequest",
+ "description": "The request for Datastore.Lookup.",
+ "type": "object"
},
"QueryResultBatch": {
- "description": "A batch of results produced by a query.",
- "type": "object",
"properties": {
- "entityResults": {
- "items": {
- "$ref": "EntityResult"
- },
- "type": "array",
- "description": "The results for this batch."
- },
"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.",
@@ -1128,7 +879,9 @@
"MORE_RESULTS_AFTER_LIMIT",
"MORE_RESULTS_AFTER_CURSOR",
"NO_MORE_RESULTS"
- ]
+ ],
+ "description": "The state of the query after the current batch.",
+ "type": "string"
},
"endCursor": {
"format": "byte",
@@ -1165,13 +918,20 @@
],
"description": "The result type for every entity in `entity_results`.",
"type": "string"
+ },
+ "entityResults": {
+ "description": "The results for this batch.",
+ "items": {
+ "$ref": "EntityResult"
+ },
+ "type": "array"
}
},
- "id": "QueryResultBatch"
+ "id": "QueryResultBatch",
+ "description": "A batch of results produced by a query.",
+ "type": "object"
},
"GoogleDatastoreAdminV1beta1Progress": {
- "description": "Measures the progress of a particular metric.",
- "type": "object",
"properties": {
"workCompleted": {
"format": "int64",
@@ -1184,9 +944,13 @@
"type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1Progress"
+ "id": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "Measures the progress of a particular metric.",
+ "type": "object"
},
"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": {
"id": {
"format": "int64",
@@ -1202,24 +966,18 @@
"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"
+ "id": "PathElement"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
- "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"
},
@@ -1229,13 +987,15 @@
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"id": "Status"
},
"GqlQueryParameter": {
- "description": "A binding parameter for a GQL query.",
- "type": "object",
"properties": {
"cursor": {
"format": "byte",
@@ -1247,7 +1007,9 @@
"description": "A value parameter."
}
},
- "id": "GqlQueryParameter"
+ "id": "GqlQueryParameter",
+ "description": "A binding parameter for a GQL query.",
+ "type": "object"
},
"GoogleLongrunningListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -1258,11 +1020,11 @@
"type": "string"
},
"operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleLongrunningOperation"
},
- "type": "array",
- "description": "A list of operations that matches the specified filter in the request."
+ "type": "array"
}
},
"id": "GoogleLongrunningListOperationsResponse"
@@ -1280,8 +1042,6 @@
"id": "BeginTransactionResponse"
},
"AllocateIdsRequest": {
- "description": "The request for Datastore.AllocateIds.",
- "type": "object",
"properties": {
"keys": {
"description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
@@ -1291,22 +1051,24 @@
"type": "array"
}
},
- "id": "AllocateIdsRequest"
+ "id": "AllocateIdsRequest",
+ "description": "The request for Datastore.AllocateIds.",
+ "type": "object"
},
"RunQueryResponse": {
- "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": {
+ "$ref": "Query",
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set."
}
},
"id": "RunQueryResponse",
- "description": "The response for Datastore.RunQuery."
+ "description": "The response for Datastore.RunQuery.",
+ "type": "object"
},
"LookupResponse": {
"description": "The response for Datastore.Lookup.",
@@ -1337,26 +1099,27 @@
"id": "LookupResponse"
},
"CommitRequest": {
+ "description": "The request for Datastore.Commit.",
"type": "object",
"properties": {
"transaction": {
- "type": "string",
"format": "byte",
- "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction."
+ "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "type": "string"
},
"mode": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
- "Non-transactional: The mutations may not apply as all or none."
- ],
"enum": [
"MODE_UNSPECIFIED",
"TRANSACTIONAL",
"NON_TRANSACTIONAL"
],
"description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
+ "Non-transactional: The mutations may not apply as all or none."
+ ]
},
"mutations": {
"description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
@@ -1366,11 +1129,9 @@
"type": "array"
}
},
- "id": "CommitRequest",
- "description": "The request for Datastore.Commit."
+ "id": "CommitRequest"
},
"BeginTransactionRequest": {
- "id": "BeginTransactionRequest",
"description": "The request for Datastore.BeginTransaction.",
"type": "object",
"properties": {
@@ -1378,35 +1139,35 @@
"$ref": "TransactionOptions",
"description": "Options for a new transaction."
}
- }
+ },
+ "id": "BeginTransactionRequest"
},
"PropertyOrder": {
- "description": "The desired order for a specific property.",
- "type": "object",
"properties": {
"direction": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Ascending.",
- "Descending."
- ],
"enum": [
"DIRECTION_UNSPECIFIED",
"ASCENDING",
"DESCENDING"
],
"description": "The direction to order by. Defaults to `ASCENDING`.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Ascending.",
+ "Descending."
+ ]
},
"property": {
- "description": "The property to order by.",
- "$ref": "PropertyReference"
+ "$ref": "PropertyReference",
+ "description": "The property to order by."
}
},
- "id": "PropertyOrder"
+ "id": "PropertyOrder",
+ "description": "The desired order for a specific property.",
+ "type": "object"
},
"KindExpression": {
- "type": "object",
"properties": {
"name": {
"description": "The name of the kind.",
@@ -1414,26 +1175,29 @@
}
},
"id": "KindExpression",
- "description": "A representation of a kind."
+ "description": "A representation of a kind.",
+ "type": "object"
},
"LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
"properties": {
- "latitude": {
- "format": "double",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "type": "number"
- },
"longitude": {
"format": "double",
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"type": "number"
+ },
+ "latitude": {
+ "format": "double",
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "type": "number"
}
},
- "id": "LatLng"
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object"
},
"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.",
@@ -1447,48 +1211,284 @@
"description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
}
},
- "id": "Key",
- "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
- "type": "object"
+ "id": "Key"
},
"PropertyReference": {
"description": "A reference to a property relative to the 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."
+ "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
+ "type": "string"
}
},
"id": "PropertyReference"
},
"GoogleDatastoreAdminV1beta1EntityFilter": {
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kind + namespace (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
- "type": "object",
"properties": {
- "kinds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "If empty, then this represents all kinds."
- },
"namespaceIds": {
"description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "kinds": {
+ "description": "If empty, then this represents all kinds.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "GoogleDatastoreAdminV1beta1EntityFilter"
+ "id": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kind + namespace (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
+ "type": "object"
+ },
+ "GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "type": "object",
+ "properties": {
+ "state": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Request is being prepared for processing.",
+ "Request is actively being processed.",
+ "Request is in the process of being cancelled after user called\nlongrunning.Operations.CancelOperation on the operation.",
+ "Request has been processed and is in its finalization stage.",
+ "Request has completed successfully.",
+ "Request has finished being processed, but encountered an error.",
+ "Request has finished being cancelled after user called\nlongrunning.Operations.CancelOperation."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "INITIALIZING",
+ "PROCESSING",
+ "CANCELLING",
+ "FINALIZING",
+ "SUCCESSFUL",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "The current state of the Operation.",
+ "type": "string"
+ },
+ "operationType": {
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "EXPORT_ENTITIES",
+ "IMPORT_ENTITIES",
+ "BUILD_INDEX",
+ "CLEAR_INDEX"
+ ],
+ "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "ExportEntities.",
+ "ImportEntities.",
+ "Build an index.",
+ "Clear an index."
+ ]
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The time that work began on the operation.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
+ "type": "object"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The time the operation ended, either successfully or otherwise.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ },
+ "Projection": {
+ "description": "A representation of a property in a projection.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "PropertyReference",
+ "description": "The property to project."
+ }
+ },
+ "id": "Projection"
+ },
+ "ArrayValue": {
+ "properties": {
+ "values": {
+ "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
+ "items": {
+ "$ref": "Value"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ArrayValue",
+ "description": "An array value.",
+ "type": "object"
+ },
+ "Mutation": {
+ "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."
+ },
+ "baseVersion": {
+ "format": "int64",
+ "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
+ "type": "string"
+ },
+ "insert": {
+ "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete.",
+ "$ref": "Entity"
+ },
+ "update": {
+ "$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."
+ }
+ },
+ "id": "Mutation",
+ "description": "A mutation to apply to an entity.",
+ "type": "object"
+ },
+ "ReadOptions": {
+ "description": "The options shared by read requests.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "format": "byte",
+ "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "type": "string"
+ },
+ "readConsistency": {
+ "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"
+ }
+ },
+ "id": "ReadOptions"
+ },
+ "RollbackResponse": {
+ "description": "The response for Datastore.Rollback.\n(an empty message).",
+ "type": "object",
+ "properties": {},
+ "id": "RollbackResponse"
+ },
+ "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
+ "properties": {
+ "outputUrl": {
+ "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse",
+ "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
+ "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": {
+ "format": "int64",
+ "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
+ "type": "string"
+ }
+ },
+ "id": "MutationResult",
+ "description": "The result of applying a mutation.",
+ "type": "object"
+ },
+ "GqlQuery": {
+ "properties": {
+ "queryString": {
+ "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "string"
+ },
+ "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.",
+ "items": {
+ "$ref": "GqlQueryParameter"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "GqlQuery",
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "object"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
"version": "v1",
- "baseUrl": "https://datastore.googleapis.com/"
+ "baseUrl": "https://datastore.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/datastore": {
+ "description": "View and manage your Google Cloud Datastore data"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://datastore.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "datastore",
+ "batchPath": "batch",
+ "revision": "20170821",
+ "documentationLink": "https://cloud.google.com/datastore/",
+ "id": "datastore:v1",
+ "title": "Google Cloud Datastore API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": true
}
diff --git a/datastore/v1beta3/datastore-api.json b/datastore/v1beta3/datastore-api.json
index 2cfe4ed..543ce1e 100644
--- a/datastore/v1beta3/datastore-api.json
+++ b/datastore/v1beta3/datastore-api.json
@@ -1,39 +1,44 @@
{
+ "title": "Google Cloud Datastore API",
"ownerName": "Google",
"discoveryVersion": "v1",
"version_module": true,
"resources": {
"projects": {
"methods": {
- "allocateIds": {
- "id": "datastore.projects.allocateIds",
- "path": "v1beta3/projects/{projectId}:allocateIds",
+ "beginTransaction": {
"request": {
- "$ref": "AllocateIdsRequest"
+ "$ref": "BeginTransactionRequest"
},
- "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
- "response": {
- "$ref": "AllocateIdsResponse"
- },
+ "description": "Begins a new transaction.",
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "BeginTransactionResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"parameters": {
"projectId": {
- "location": "path",
"description": "The ID of the project against which to make the request.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
- "flatPath": "v1beta3/projects/{projectId}:allocateIds"
+ "flatPath": "v1beta3/projects/{projectId}:beginTransaction",
+ "path": "v1beta3/projects/{projectId}:beginTransaction",
+ "id": "datastore.projects.beginTransaction"
},
"commit": {
+ "request": {
+ "$ref": "CommitRequest"
+ },
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
"httpMethod": "POST",
"parameterOrder": [
"projectId"
@@ -55,41 +60,10 @@
},
"flatPath": "v1beta3/projects/{projectId}:commit",
"path": "v1beta3/projects/{projectId}:commit",
- "id": "datastore.projects.commit",
- "request": {
- "$ref": "CommitRequest"
- },
- "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities."
- },
- "beginTransaction": {
- "response": {
- "$ref": "BeginTransactionResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the project against which to make the request.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta3/projects/{projectId}:beginTransaction",
- "id": "datastore.projects.beginTransaction",
- "path": "v1beta3/projects/{projectId}:beginTransaction",
- "description": "Begins a new transaction.",
- "request": {
- "$ref": "BeginTransactionRequest"
- }
+ "id": "datastore.projects.commit"
},
"runQuery": {
+ "flatPath": "v1beta3/projects/{projectId}:runQuery",
"id": "datastore.projects.runQuery",
"path": "v1beta3/projects/{projectId}:runQuery",
"description": "Queries for entities.",
@@ -105,6 +79,31 @@
"httpMethod": "POST",
"parameters": {
"projectId": {
+ "description": "The ID of the project against which to make the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ]
+ },
+ "rollback": {
+ "description": "Rolls back a transaction.",
+ "request": {
+ "$ref": "RollbackRequest"
+ },
+ "response": {
+ "$ref": "RollbackResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
"location": "path",
"description": "The ID of the project against which to make the request.",
"type": "string",
@@ -115,39 +114,11 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta3/projects/{projectId}:runQuery"
- },
- "rollback": {
- "request": {
- "$ref": "RollbackRequest"
- },
- "description": "Rolls back a transaction.",
- "response": {
- "$ref": "RollbackResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
"flatPath": "v1beta3/projects/{projectId}:rollback",
"id": "datastore.projects.rollback",
"path": "v1beta3/projects/{projectId}:rollback"
},
"lookup": {
- "path": "v1beta3/projects/{projectId}:lookup",
- "id": "datastore.projects.lookup",
"description": "Looks up entities by key.",
"request": {
"$ref": "LookupRequest"
@@ -171,77 +142,42 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta3/projects/{projectId}:lookup"
+ "flatPath": "v1beta3/projects/{projectId}:lookup",
+ "path": "v1beta3/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup"
+ },
+ "allocateIds": {
+ "request": {
+ "$ref": "AllocateIdsRequest"
+ },
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
+ "response": {
+ "$ref": "AllocateIdsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the project against which to make the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta3/projects/{projectId}:allocateIds",
+ "id": "datastore.projects.allocateIds",
+ "path": "v1beta3/projects/{projectId}:allocateIds"
}
}
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "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"
- },
- "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",
@@ -254,56 +190,149 @@
"type": "boolean"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "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.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "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"
}
},
"schemas": {
+ "MutationResult": {
+ "description": "The result of applying a mutation.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "format": "int64",
+ "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
+ "type": "string"
+ },
+ "conflictDetected": {
+ "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
+ "type": "boolean"
+ },
+ "key": {
+ "$ref": "Key",
+ "description": "The automatically allocated key.\nSet only when the mutation allocated a key."
+ }
+ },
+ "id": "MutationResult"
+ },
+ "GqlQuery": {
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "object",
+ "properties": {
+ "queryString": {
+ "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "string"
+ },
+ "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.",
+ "items": {
+ "$ref": "GqlQueryParameter"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "GqlQuery"
+ },
"Filter": {
"description": "A holder for any type of filter.",
"type": "object",
"properties": {
"compositeFilter": {
- "description": "A composite filter.",
- "$ref": "CompositeFilter"
+ "$ref": "CompositeFilter",
+ "description": "A composite filter."
},
"propertyFilter": {
- "description": "A filter on a property.",
- "$ref": "PropertyFilter"
+ "$ref": "PropertyFilter",
+ "description": "A filter on a property."
}
},
"id": "Filter"
},
- "RunQueryRequest": {
- "properties": {
- "readOptions": {
- "description": "The options for this query.",
- "$ref": "ReadOptions"
- },
- "query": {
- "description": "The query to run.",
- "$ref": "Query"
- },
- "gqlQuery": {
- "$ref": "GqlQuery",
- "description": "The GQL query to run."
- },
- "partitionId": {
- "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID.",
- "$ref": "PartitionId"
- }
- },
- "id": "RunQueryRequest",
- "description": "The request for Datastore.RunQuery.",
- "type": "object"
- },
"RollbackRequest": {
+ "description": "The request for Datastore.Rollback.",
+ "type": "object",
"properties": {
"transaction": {
"format": "byte",
@@ -311,18 +340,35 @@
"type": "string"
}
},
- "id": "RollbackRequest",
- "description": "The request for Datastore.Rollback.",
- "type": "object"
+ "id": "RollbackRequest"
+ },
+ "RunQueryRequest": {
+ "description": "The request for Datastore.RunQuery.",
+ "type": "object",
+ "properties": {
+ "gqlQuery": {
+ "description": "The GQL query to run.",
+ "$ref": "GqlQuery"
+ },
+ "partitionId": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID."
+ },
+ "readOptions": {
+ "description": "The options for this query.",
+ "$ref": "ReadOptions"
+ },
+ "query": {
+ "description": "The query to run.",
+ "$ref": "Query"
+ }
+ },
+ "id": "RunQueryRequest"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"description": "Metadata for ExportEntities operations.",
"type": "object",
"properties": {
- "progressEntities": {
- "description": "An estimate of the number of entities processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
- },
"common": {
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations."
@@ -336,8 +382,12 @@
"type": "string"
},
"entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being exported."
+ "description": "Description of which entities are being exported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
+ },
+ "progressEntities": {
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of entities processed."
}
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
@@ -351,8 +401,8 @@
"$ref": "ReadOnly"
},
"readWrite": {
- "description": "The transaction should allow both reads and writes.",
- "$ref": "ReadWrite"
+ "$ref": "ReadWrite",
+ "description": "The transaction should allow both reads and writes."
}
},
"id": "TransactionOptions"
@@ -369,6 +419,8 @@
"type": "array"
},
"op": {
+ "description": "The operator for combining multiple filters.",
+ "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"The results are required to satisfy each of the combined filters."
@@ -376,9 +428,7 @@
"enum": [
"OPERATOR_UNSPECIFIED",
"AND"
- ],
- "description": "The operator for combining multiple filters.",
- "type": "string"
+ ]
}
},
"id": "CompositeFilter"
@@ -387,10 +437,6 @@
"description": "Metadata for ImportEntities operations.",
"type": "object",
"properties": {
- "progressEntities": {
- "description": "An estimate of the number of entities processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
- },
"common": {
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations."
@@ -404,8 +450,12 @@
"description": "An estimate of the number of bytes processed."
},
"entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being imported."
+ "description": "Description of which entities are being imported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
+ },
+ "progressEntities": {
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
}
},
"id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
@@ -425,7 +475,16 @@
"id": "AllocateIdsResponse"
},
"Query": {
+ "description": "A query for entities.",
+ "type": "object",
"properties": {
+ "projection": {
+ "description": "The projection to return. Defaults to returning all properties.",
+ "items": {
+ "$ref": "Projection"
+ },
+ "type": "array"
+ },
"endCursor": {
"format": "byte",
"description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
@@ -437,8 +496,8 @@
"type": "integer"
},
"filter": {
- "$ref": "Filter",
- "description": "The filter to apply."
+ "description": "The filter to apply.",
+ "$ref": "Filter"
},
"offset": {
"format": "int32",
@@ -470,18 +529,9 @@
"$ref": "PropertyOrder"
},
"type": "array"
- },
- "projection": {
- "description": "The projection to return. Defaults to returning all properties.",
- "items": {
- "$ref": "Projection"
- },
- "type": "array"
}
},
- "id": "Query",
- "description": "A query for entities.",
- "type": "object"
+ "id": "Query"
},
"ReadOnly": {
"description": "Options specific to read-only transactions.",
@@ -493,10 +543,6 @@
"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."
@@ -522,12 +568,22 @@
],
"description": "The operator to filter by.",
"type": "string"
+ },
+ "value": {
+ "description": "The value to compare the property to.",
+ "$ref": "Value"
}
},
"id": "PropertyFilter"
},
"EntityResult": {
+ "description": "The result of fetching an entity from Datastore.",
+ "type": "object",
"properties": {
+ "entity": {
+ "$ref": "Entity",
+ "description": "The resulting entity."
+ },
"cursor": {
"format": "byte",
"description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.",
@@ -537,51 +593,33 @@
"format": "int64",
"description": "The version of the entity, a strictly positive number that monotonically\nincreases with changes to the entity.\n\nThis field is set for `FULL` entity\nresults.\n\nFor missing entities in `LookupResponse`, this\nis the version of the snapshot that was used to look up the entity, and it\nis always set except for eventually consistent reads.",
"type": "string"
- },
- "entity": {
- "$ref": "Entity",
- "description": "The resulting entity."
}
},
- "id": "EntityResult",
- "description": "The result of fetching an entity from Datastore.",
- "type": "object"
+ "id": "EntityResult"
},
- "Value": {
+ "CommitResponse": {
+ "description": "The response for Datastore.Commit.",
+ "type": "object",
"properties": {
- "timestampValue": {
- "format": "google-datetime",
- "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
- "type": "string"
- },
- "nullValue": {
- "enum": [
- "NULL_VALUE"
- ],
- "description": "A null value.",
- "type": "string",
- "enumDescriptions": [
- "Null value."
- ]
- },
- "booleanValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
- "blobValue": {
- "format": "byte",
- "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
- "type": "string"
- },
- "meaning": {
+ "indexUpdates": {
"format": "int32",
- "description": "The `meaning` field should only be populated for backwards compatibility.",
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
"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`."
- },
+ "mutationResults": {
+ "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
+ "items": {
+ "$ref": "MutationResult"
+ },
+ "type": "array"
+ }
+ },
+ "id": "CommitResponse"
+ },
+ "Value": {
+ "description": "A message that can hold any of the supported value types and associated\nmetadata.",
+ "type": "object",
+ "properties": {
"entityValue": {
"description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.",
"$ref": "Entity"
@@ -591,8 +629,8 @@
"$ref": "LatLng"
},
"keyValue": {
- "description": "A key value.",
- "$ref": "Key"
+ "$ref": "Key",
+ "description": "A key value."
},
"integerValue": {
"format": "int64",
@@ -611,32 +649,46 @@
"format": "double",
"description": "A double value.",
"type": "number"
- }
- },
- "id": "Value",
- "description": "A message that can hold any of the supported value types and associated\nmetadata.",
- "type": "object"
- },
- "CommitResponse": {
- "properties": {
- "mutationResults": {
- "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
- "items": {
- "$ref": "MutationResult"
- },
- "type": "array"
},
- "indexUpdates": {
+ "timestampValue": {
+ "format": "google-datetime",
+ "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
+ "type": "string"
+ },
+ "nullValue": {
+ "enumDescriptions": [
+ "Null value."
+ ],
+ "enum": [
+ "NULL_VALUE"
+ ],
+ "description": "A null value.",
+ "type": "string"
+ },
+ "booleanValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
+ "blobValue": {
+ "format": "byte",
+ "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
+ "type": "string"
+ },
+ "meaning": {
"format": "int32",
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ "description": "The `meaning` field should only be populated for backwards compatibility.",
"type": "integer"
+ },
+ "arrayValue": {
+ "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`.",
+ "$ref": "ArrayValue"
}
},
- "id": "CommitResponse",
- "description": "The response for Datastore.Commit.",
- "type": "object"
+ "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": {
"projectId": {
"description": "The ID of the project to which the entities belong.",
@@ -647,11 +699,29 @@
"type": "string"
}
},
- "id": "PartitionId",
- "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\nForeign partition IDs (in which the project ID does\nnot match the context project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.",
- "type": "object"
+ "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": {
+ "key": {
+ "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key.",
+ "$ref": "Key"
+ },
+ "properties": {
+ "additionalProperties": {
+ "$ref": "Value"
+ },
+ "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
+ "type": "object"
+ }
+ },
+ "id": "Entity"
},
"ReadWrite": {
+ "description": "Options specific to read / write transactions.",
+ "type": "object",
"properties": {
"previousTransaction": {
"format": "byte",
@@ -659,45 +729,7 @@
"type": "string"
}
},
- "id": "ReadWrite",
- "description": "Options specific to read / write transactions.",
- "type": "object"
- },
- "Entity": {
- "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": {
- "$ref": "Key",
- "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key."
- }
- },
- "id": "Entity",
- "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"
- },
- "LookupRequest": {
- "description": "The request for Datastore.Lookup.",
- "type": "object",
- "properties": {
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this lookup request."
- },
- "keys": {
- "description": "Keys of entities to look up.",
- "items": {
- "$ref": "Key"
- },
- "type": "array"
- }
- },
- "id": "LookupRequest"
+ "id": "ReadWrite"
},
"GoogleDatastoreAdminV1beta1Progress": {
"description": "Measures the progress of a particular metric.",
@@ -717,46 +749,17 @@
"id": "GoogleDatastoreAdminV1beta1Progress"
},
"QueryResultBatch": {
+ "description": "A batch of results produced by a query.",
+ "type": "object",
"properties": {
- "skippedCursor": {
- "format": "byte",
- "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
- "type": "string"
- },
- "skippedResults": {
- "format": "int32",
- "description": "The number of results skipped, typically because of an offset.",
- "type": "integer"
- },
- "entityResultType": {
- "enum": [
- "RESULT_TYPE_UNSPECIFIED",
- "FULL",
- "PROJECTION",
- "KEY_ONLY"
- ],
- "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."
- ]
- },
- "entityResults": {
- "description": "The results for this batch.",
- "items": {
- "$ref": "EntityResult"
- },
- "type": "array"
- },
"endCursor": {
"format": "byte",
"description": "A cursor that points to the position after the last result in the batch.",
"type": "string"
},
"moreResults": {
+ "description": "The state of the query after the current batch.",
+ "type": "string",
"enumDescriptions": [
"Unspecified. This value is never used.",
"There may be additional batches to fetch from this query.",
@@ -770,24 +773,75 @@
"MORE_RESULTS_AFTER_LIMIT",
"MORE_RESULTS_AFTER_CURSOR",
"NO_MORE_RESULTS"
- ],
- "description": "The state of the query after the current batch.",
- "type": "string"
+ ]
},
"snapshotVersion": {
"format": "int64",
"description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
"type": "string"
+ },
+ "skippedCursor": {
+ "format": "byte",
+ "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
+ "type": "string"
+ },
+ "skippedResults": {
+ "format": "int32",
+ "description": "The number of results skipped, typically because of an offset.",
+ "type": "integer"
+ },
+ "entityResultType": {
+ "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"
+ ]
+ },
+ "entityResults": {
+ "description": "The results for this batch.",
+ "items": {
+ "$ref": "EntityResult"
+ },
+ "type": "array"
}
},
- "id": "QueryResultBatch",
- "description": "A batch of results produced by a query.",
- "type": "object"
+ "id": "QueryResultBatch"
+ },
+ "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.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
+ }
+ },
+ "id": "LookupRequest"
},
"PathElement": {
"description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
"type": "object",
"properties": {
+ "kind": {
+ "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
"id": {
"format": "int64",
"description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
@@ -796,15 +850,13 @@
"name": {
"description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
"type": "string"
- },
- "kind": {
- "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
}
},
"id": "PathElement"
},
"GqlQueryParameter": {
+ "description": "A binding parameter for a GQL query.",
+ "type": "object",
"properties": {
"cursor": {
"format": "byte",
@@ -812,15 +864,15 @@
"type": "string"
},
"value": {
- "$ref": "Value",
- "description": "A value parameter."
+ "description": "A value parameter.",
+ "$ref": "Value"
}
},
- "id": "GqlQueryParameter",
- "description": "A binding parameter for a GQL query.",
- "type": "object"
+ "id": "GqlQueryParameter"
},
"BeginTransactionResponse": {
+ "description": "The response for Datastore.BeginTransaction.",
+ "type": "object",
"properties": {
"transaction": {
"format": "byte",
@@ -828,48 +880,27 @@
"type": "string"
}
},
- "id": "BeginTransactionResponse",
- "description": "The response for Datastore.BeginTransaction.",
- "type": "object"
+ "id": "BeginTransactionResponse"
},
"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."
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set.",
+ "$ref": "Query"
},
"batch": {
"description": "A batch of query results (always present).",
"$ref": "QueryResultBatch"
}
},
- "id": "RunQueryResponse",
- "description": "The response for Datastore.RunQuery.",
- "type": "object"
- },
- "AllocateIdsRequest": {
- "properties": {
- "keys": {
- "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
- "items": {
- "$ref": "Key"
- },
- "type": "array"
- }
- },
- "id": "AllocateIdsRequest",
- "description": "The request for Datastore.AllocateIds.",
- "type": "object"
+ "id": "RunQueryResponse"
},
"LookupResponse": {
+ "description": "The response for Datastore.Lookup.",
+ "type": "object",
"properties": {
- "deferred": {
- "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
- "items": {
- "$ref": "Key"
- },
- "type": "array"
- },
"missing": {
"description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
"items": {
@@ -883,15 +914,82 @@
"$ref": "EntityResult"
},
"type": "array"
+ },
+ "deferred": {
+ "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
}
},
- "id": "LookupResponse",
- "description": "The response for Datastore.Lookup.",
- "type": "object"
+ "id": "LookupResponse"
+ },
+ "AllocateIdsRequest": {
+ "description": "The request for Datastore.AllocateIds.",
+ "type": "object",
+ "properties": {
+ "keys": {
+ "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AllocateIdsRequest"
+ },
+ "CommitRequest": {
+ "description": "The request for Datastore.Commit.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "format": "byte",
+ "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "type": "string"
+ },
+ "mode": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
+ "Non-transactional: The mutations may not apply as all or none."
+ ],
+ "enum": [
+ "MODE_UNSPECIFIED",
+ "TRANSACTIONAL",
+ "NON_TRANSACTIONAL"
+ ],
+ "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
+ "type": "string"
+ },
+ "mutations": {
+ "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
+ "items": {
+ "$ref": "Mutation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "CommitRequest"
+ },
+ "BeginTransactionRequest": {
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "transactionOptions": {
+ "$ref": "TransactionOptions",
+ "description": "Options for a new transaction."
+ }
+ },
+ "id": "BeginTransactionRequest"
},
"PropertyOrder": {
+ "description": "The desired order for a specific property.",
+ "type": "object",
"properties": {
"direction": {
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
+ "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Ascending.",
@@ -901,93 +999,47 @@
"DIRECTION_UNSPECIFIED",
"ASCENDING",
"DESCENDING"
- ],
- "description": "The direction to order by. Defaults to `ASCENDING`.",
- "type": "string"
+ ]
},
"property": {
"description": "The property to order by.",
"$ref": "PropertyReference"
}
},
- "id": "PropertyOrder",
- "description": "The desired order for a specific property.",
- "type": "object"
- },
- "BeginTransactionRequest": {
- "properties": {
- "transactionOptions": {
- "$ref": "TransactionOptions",
- "description": "Options for a new transaction."
- }
- },
- "id": "BeginTransactionRequest",
- "description": "The request for Datastore.BeginTransaction.",
- "type": "object"
- },
- "CommitRequest": {
- "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.",
- "items": {
- "$ref": "Mutation"
- },
- "type": "array"
- },
- "transaction": {
- "format": "byte",
- "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "type": "string"
- },
- "mode": {
- "enum": [
- "MODE_UNSPECIFIED",
- "TRANSACTIONAL",
- "NON_TRANSACTIONAL"
- ],
- "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
- "Non-transactional: The mutations may not apply as all or none."
- ]
- }
- },
- "id": "CommitRequest",
- "description": "The request for Datastore.Commit.",
- "type": "object"
+ "id": "PropertyOrder"
},
"KindExpression": {
+ "description": "A representation of a kind.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the kind.",
"type": "string"
}
},
- "id": "KindExpression",
- "description": "A representation of a kind.",
- "type": "object"
+ "id": "KindExpression"
},
"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.",
"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",
- "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
- "type": "object"
+ "id": "Key"
},
"LatLng": {
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object",
"properties": {
"latitude": {
"format": "double",
@@ -1000,43 +1052,43 @@
"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"
+ "id": "LatLng"
},
"PropertyReference": {
+ "description": "A reference to a property relative to the kind expressions.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
"type": "string"
}
},
- "id": "PropertyReference",
- "description": "A reference to a property relative to the kind expressions.",
- "type": "object"
+ "id": "PropertyReference"
},
"GoogleDatastoreAdminV1beta1EntityFilter": {
+ "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kind + namespace (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
+ "type": "object",
"properties": {
- "namespaceIds": {
- "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"kinds": {
"description": "If empty, then this represents all kinds.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "namespaceIds": {
+ "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kind + namespace (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
- "type": "object"
+ "id": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "type": "object",
"properties": {
"labels": {
"additionalProperties": {
@@ -1051,16 +1103,6 @@
"type": "string"
},
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "INITIALIZING",
- "PROCESSING",
- "CANCELLING",
- "FINALIZING",
- "SUCCESSFUL",
- "FAILED",
- "CANCELLED"
- ],
"description": "The current state of the Operation.",
"type": "string",
"enumDescriptions": [
@@ -1072,9 +1114,21 @@
"Request has completed successfully.",
"Request has finished being processed, but encountered an error.",
"Request has finished being cancelled after user called\nlongrunning.Operations.CancelOperation."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "INITIALIZING",
+ "PROCESSING",
+ "CANCELLING",
+ "FINALIZING",
+ "SUCCESSFUL",
+ "FAILED",
+ "CANCELLED"
]
},
"operationType": {
+ "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
+ "type": "string",
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
@@ -1088,9 +1142,7 @@
"IMPORT_ENTITIES",
"BUILD_INDEX",
"CLEAR_INDEX"
- ],
- "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
- "type": "string"
+ ]
},
"startTime": {
"format": "google-datetime",
@@ -1098,17 +1150,15 @@
"type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations.",
- "type": "object"
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
},
"Projection": {
"description": "A representation of a property in a projection.",
"type": "object",
"properties": {
"property": {
- "description": "The property to project.",
- "$ref": "PropertyReference"
+ "$ref": "PropertyReference",
+ "description": "The property to project."
}
},
"id": "Projection"
@@ -1128,15 +1178,9 @@
"id": "ArrayValue"
},
"Mutation": {
+ "description": "A mutation to apply to an entity.",
+ "type": "object",
"properties": {
- "update": {
- "$ref": "Entity",
- "description": "The entity to update. The entity must already exist.\nMust have a complete key path."
- },
- "upsert": {
- "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete.",
- "$ref": "Entity"
- },
"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."
@@ -1147,13 +1191,19 @@
"type": "string"
},
"insert": {
- "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete.",
- "$ref": "Entity"
+ "$ref": "Entity",
+ "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
+ },
+ "update": {
+ "$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."
}
},
- "id": "Mutation",
- "description": "A mutation to apply to an entity.",
- "type": "object"
+ "id": "Mutation"
},
"ReadOptions": {
"description": "The options shared by read requests.",
@@ -1165,6 +1215,8 @@
"type": "string"
},
"readConsistency": {
+ "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
+ "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Strong consistency.",
@@ -1174,109 +1226,57 @@
"READ_CONSISTENCY_UNSPECIFIED",
"STRONG",
"EVENTUAL"
- ],
- "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
- "type": "string"
+ ]
}
},
"id": "ReadOptions"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
+ "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
+ "type": "object",
"properties": {
"outputUrl": {
"description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
"type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse",
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
- "type": "object"
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse"
},
"RollbackResponse": {
"description": "The response for Datastore.Rollback.\n(an empty message).",
"type": "object",
"properties": {},
"id": "RollbackResponse"
- },
- "MutationResult": {
- "properties": {
- "version": {
- "format": "int64",
- "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
- "type": "string"
- },
- "conflictDetected": {
- "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
- "type": "boolean"
- },
- "key": {
- "description": "The automatically allocated key.\nSet only when the mutation allocated a key.",
- "$ref": "Key"
- }
- },
- "id": "MutationResult",
- "description": "The result of applying a mutation.",
- "type": "object"
- },
- "GqlQuery": {
- "properties": {
- "queryString": {
- "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
- "type": "string"
- },
- "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.",
- "items": {
- "$ref": "GqlQueryParameter"
- },
- "type": "array"
- },
- "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"
- },
- "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"
- }
- },
- "id": "GqlQuery",
- "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
- "type": "object"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v1beta3",
"baseUrl": "https://datastore.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/datastore": {
"description": "View and manage your Google Cloud Datastore data"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
- "kind": "discovery#restDescription",
- "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
"servicePath": "",
+ "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
+ "kind": "discovery#restDescription",
"rootUrl": "https://datastore.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "datastore",
"batchPath": "batch",
"id": "datastore:v1beta3",
- "revision": "20170815",
"documentationLink": "https://cloud.google.com/datastore/",
- "title": "Google Cloud Datastore API"
+ "revision": "20170821"
}
diff --git a/dlp/v2beta1/dlp-api.json b/dlp/v2beta1/dlp-api.json
index 521a381..ce15114 100644
--- a/dlp/v2beta1/dlp-api.json
+++ b/dlp/v2beta1/dlp-api.json
@@ -1,25 +1,721 @@
{
- "id": "dlp:v2beta1",
+ "resources": {
+ "inspect": {
+ "resources": {
+ "operations": {
+ "methods": {
+ "delete": {
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations/{operationsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.inspect.operations.delete"
+ },
+ "get": {
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/inspect/operations/{operationsId}",
+ "id": "dlp.inspect.operations.get",
+ "path": "v2beta1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunningListOperationsResponse"
+ },
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "This parameter supports filtering by done, ie done=true or done=false.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^inspect/operations$"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The list page size. The max allowed value is 256 and default is 100.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.inspect.operations.list",
+ "description": "Fetch the list of long running operations."
+ },
+ "create": {
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations",
+ "id": "dlp.inspect.operations.create",
+ "path": "v2beta1/inspect/operations",
+ "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
+ }
+ },
+ "cancel": {
+ "id": "dlp.inspect.operations.cancel",
+ "path": "v2beta1/{+name}:cancel",
+ "description": "Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
+ "request": {
+ "$ref": "GoogleLongrunningCancelOperationRequest"
+ },
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^inspect/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel"
+ }
+ }
+ },
+ "results": {
+ "resources": {
+ "findings": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "Restricts 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"
+ },
+ "pageToken": {
+ "description": "The value returned by the last `ListInspectFindingsResponse`; indicates\nthat this is a continuation of a prior `ListInspectFindings` call, and that\nthe system should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "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}`.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of results to return.\nIf 0, the implementation selects a reasonable value.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/results/{resultsId}/findings",
+ "id": "dlp.inspect.results.findings.list",
+ "path": "v2beta1/{+name}/findings",
+ "description": "Returns list of results for given inspect operation result set id."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "rootCategories": {
+ "methods": {
+ "list": {
+ "description": "Returns the list of root categories of sensitive information.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "languageCode": {
+ "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/rootCategories",
+ "id": "dlp.rootCategories.list",
+ "path": "v2beta1/rootCategories"
+ }
+ },
+ "resources": {
+ "infoTypes": {
+ "methods": {
+ "list": {
+ "description": "Returns sensitive information types for given category.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
+ },
+ "parameterOrder": [
+ "category"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "category": {
+ "location": "path",
+ "description": "Category name as returned by ListRootCategories.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes",
+ "id": "dlp.rootCategories.infoTypes.list",
+ "path": "v2beta1/rootCategories/{+category}/infoTypes"
+ }
+ }
+ }
+ }
+ },
+ "content": {
+ "methods": {
+ "inspect": {
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/content:inspect",
+ "id": "dlp.content.inspect",
+ "path": "v2beta1/content:inspect",
+ "description": "Finds potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectContentRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectContentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST"
+ },
+ "redact": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1RedactContentResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/content:redact",
+ "path": "v2beta1/content:redact",
+ "id": "dlp.content.redact",
+ "description": "Redacts potentially sensitive info from a list of strings.\nThis method has limits on input size, processing time, and output size.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1RedactContentRequest"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ }
+ },
+ "version": "v2beta1",
+ "baseUrl": "https://dlp.googleapis.com/",
+ "servicePath": "",
+ "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.",
+ "basePath": "",
"revision": "20170822",
"documentationLink": "https://cloud.google.com/dlp/docs/",
+ "id": "dlp:v2beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "GooglePrivacyDlpV2beta1FieldId": {
+ "description": "General identifier of a data field in a storage service.",
+ "type": "object",
+ "properties": {
+ "columnName": {
+ "description": "Name describing the field.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1FieldId"
+ },
+ "GooglePrivacyDlpV2beta1DatastoreOptions": {
+ "description": "Options defining a data set within Google Cloud Datastore.",
+ "type": "object",
+ "properties": {
+ "projection": {
+ "description": "Properties to scan. If none are specified, all properties will be scanned\nby default.",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1Projection"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "description": "The kind to process.",
+ "$ref": "GooglePrivacyDlpV2beta1KindExpression"
+ },
+ "partitionId": {
+ "$ref": "GooglePrivacyDlpV2beta1PartitionId",
+ "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1DatastoreOptions"
+ },
+ "GoogleLongrunningCancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "GoogleLongrunningCancelOperationRequest"
+ },
+ "GooglePrivacyDlpV2beta1InspectConfig": {
+ "id": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
+ "type": "object",
+ "properties": {
+ "excludeTypes": {
+ "description": "When true, excludes type information of the findings.",
+ "type": "boolean"
+ },
+ "minLikelihood": {
+ "enum": [
+ "LIKELIHOOD_UNSPECIFIED",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Only returns findings equal or above this threshold.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value; information with all likelihoods is included.",
+ "Few matching elements.",
+ "",
+ "Some matching elements.",
+ "",
+ "Many matching elements."
+ ]
+ },
+ "infoTypeLimits": {
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoTypeLimit"
+ },
+ "type": "array",
+ "description": "Configuration of findings limit given for specified info types."
+ },
+ "maxFindings": {
+ "format": "int32",
+ "description": "Limits the number of findings per content item or long running operation.",
+ "type": "integer"
+ },
+ "infoTypes": {
+ "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ },
+ "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"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1Projection": {
+ "id": "GooglePrivacyDlpV2beta1Projection",
+ "description": "A representation of a Datastore property in a projection.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "GooglePrivacyDlpV2beta1PropertyReference",
+ "description": "The property to project."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1CreateInspectOperationRequest": {
+ "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest",
+ "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
+ "type": "object",
+ "properties": {
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "Configuration for the inspector."
+ },
+ "storageConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1StorageConfig",
+ "description": "Specification of the data set to process."
+ },
+ "outputConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
+ "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\u003etimestamp\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\u003cbr/\u003e\n\u003cp\u003eFor BigQuery the next columns are: \u003cli\u003erow_number \u003cli\u003eproject_id\n\u003cli\u003edataset_id \u003cli\u003etable_id"
+ },
+ "operationConfig": {
+ "description": "Additional configuration settings for long running operations.",
+ "$ref": "GooglePrivacyDlpV2beta1OperationConfig"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1Key": {
+ "description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
+ "type": "object",
+ "properties": {
+ "partitionId": {
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.",
+ "$ref": "GooglePrivacyDlpV2beta1PartitionId"
+ },
+ "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": "GooglePrivacyDlpV2beta1PathElement"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Key"
+ },
+ "GooglePrivacyDlpV2beta1InspectContentRequest": {
+ "type": "object",
+ "properties": {
+ "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": "GooglePrivacyDlpV2beta1ContentItem"
+ },
+ "type": "array"
+ },
+ "inspectConfig": {
+ "description": "Configuration for the inspector.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InspectContentRequest",
+ "description": "Request to search for potentially sensitive info in a list of items."
+ },
+ "GoogleTypeDate": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object",
+ "properties": {
+ "day": {
+ "format": "int32",
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "type": "integer"
+ },
+ "year": {
+ "format": "int32",
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "type": "integer"
+ },
+ "month": {
+ "format": "int32",
+ "description": "Month of year. Must be from 1 to 12.",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleTypeDate"
+ },
+ "GooglePrivacyDlpV2beta1RedactContentResponse": {
+ "description": "Results of redacting a list of items.",
+ "type": "object",
+ "properties": {
+ "items": {
+ "description": "The redacted content.",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ContentItem"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1RedactContentResponse"
+ },
+ "GooglePrivacyDlpV2beta1ImageRedactionConfig": {
+ "description": "Configuration for determing how redaction of images should occur.",
+ "type": "object",
+ "properties": {
+ "redactionColor": {
+ "description": "The color to use when redacting content from an image. If not specified,\nthe default is black.",
+ "$ref": "GooglePrivacyDlpV2beta1Color"
+ },
+ "redactAllText": {
+ "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.",
+ "type": "boolean"
+ },
+ "infoType": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeStatistics": {
+ "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics",
+ "description": "Statistics regarding a specific InfoType.",
+ "type": "object",
+ "properties": {
+ "infoType": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "The type of finding this stat is for."
+ },
+ "count": {
+ "type": "string",
+ "format": "int64",
+ "description": "Number of findings for this info type."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1PropertyReference": {
+ "description": "A reference to a property relative to the Datastore kind expressions.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1PropertyReference"
+ },
+ "GooglePrivacyDlpV2beta1Location": {
+ "description": "Specifies the location of a finding within its source item.",
+ "type": "object",
+ "properties": {
+ "codepointRange": {
+ "$ref": "GooglePrivacyDlpV2beta1Range",
+ "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8."
+ },
+ "fieldId": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Field id of the field containing the finding."
+ },
+ "imageBoxes": {
+ "description": "Location within an image's pixels.",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ImageLocation"
+ },
+ "type": "array"
+ },
+ "byteRange": {
+ "$ref": "GooglePrivacyDlpV2beta1Range",
+ "description": "Zero-based byte offsets within a content item."
+ },
+ "recordKey": {
+ "description": "Key of the finding.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordKey"
+ },
+ "tableLocation": {
+ "$ref": "GooglePrivacyDlpV2beta1TableLocation",
+ "description": "Location within a `ContentItem.Table`."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Location"
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeDescription": {
+ "description": "Info type description.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Internal name of the info type."
+ },
+ "displayName": {
+ "description": "Human readable form of the info type name.",
+ "type": "string"
+ },
+ "categories": {
+ "description": "List of categories this info type belongs to.",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InfoTypeDescription"
+ },
+ "GooglePrivacyDlpV2beta1OutputStorageConfig": {
+ "description": "Cloud repository for storing output.",
+ "type": "object",
+ "properties": {
+ "table": {
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Store findings in a new table in the dataset."
+ },
+ "storagePath": {
+ "$ref": "GooglePrivacyDlpV2beta1CloudStoragePath",
+ "description": "The path to a Google Cloud Storage location to store output."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ },
"GoogleRpcStatus": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "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.",
@@ -28,23 +724,40 @@
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
}
},
"id": "GoogleRpcStatus"
},
"GoogleLongrunningOperation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
"properties": {
- "done": {
- "type": "boolean",
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable."
- },
- "response": {
+ "metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
+ "description": "This field will contain an InspectOperationMetadata object. This will always be returned with the Operation.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
"description": "This field will contain an InspectOperationResult object.",
"type": "object"
},
@@ -53,33 +766,18 @@
"type": "string"
},
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "GoogleRpcStatus"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "This field will contain an InspectOperationMetadata object. This will always be returned with the Operation.",
- "type": "object"
+ "$ref": "GoogleRpcStatus",
+ "description": "The error result of the operation in case of failure or cancellation."
}
},
- "id": "GoogleLongrunningOperation"
+ "id": "GoogleLongrunningOperation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1InspectOperationMetadata": {
"description": "Metadata returned within GetOperation for an inspect request.",
"type": "object",
"properties": {
- "requestStorageConfig": {
- "$ref": "GooglePrivacyDlpV2beta1StorageConfig",
- "description": "The storage config used to create the Operation."
- },
- "processedBytes": {
- "type": "string",
- "format": "int64",
- "description": "Total size in bytes that were processed."
- },
"totalEstimatedBytes": {
"format": "int64",
"description": "Estimate of the number of bytes to process.",
@@ -92,17 +790,26 @@
"type": "array"
},
"requestInspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "The inspect config used to create the Operation."
+ "description": "The inspect config used to create the Operation.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
},
"requestOutputConfig": {
- "description": "Optional location to store findings.",
- "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
+ "description": "Optional location to store findings."
},
"createTime": {
"format": "google-datetime",
"description": "The time which this request was started.",
"type": "string"
+ },
+ "requestStorageConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1StorageConfig",
+ "description": "The storage config used to create the Operation."
+ },
+ "processedBytes": {
+ "format": "int64",
+ "description": "Total size in bytes that were processed.",
+ "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta1InspectOperationMetadata"
@@ -123,9 +830,9 @@
"type": "object",
"properties": {
"id": {
+ "type": "string",
"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"
+ "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."
},
"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 `\"\"`.",
@@ -143,12 +850,12 @@
"type": "object",
"properties": {
"name": {
- "description": "Internal name of the category.",
- "type": "string"
+ "type": "string",
+ "description": "Internal name of the category."
},
"displayName": {
- "description": "Human readable form of the category name.",
- "type": "string"
+ "type": "string",
+ "description": "Human readable form of the category name."
}
},
"id": "GooglePrivacyDlpV2beta1CategoryDescription"
@@ -157,34 +864,34 @@
"description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
"type": "object",
"properties": {
+ "tableId": {
+ "description": "Name of the table.",
+ "type": "string"
+ },
"projectId": {
"description": "The Google Cloud Platform project ID of the project containing the table.\nIf omitted, project ID is inferred from the API call.",
"type": "string"
},
"datasetId": {
- "description": "Dataset ID of the table.",
- "type": "string"
- },
- "tableId": {
- "description": "Name of the table.",
- "type": "string"
+ "type": "string",
+ "description": "Dataset ID of the table."
}
},
"id": "GooglePrivacyDlpV2beta1BigQueryTable"
},
"GooglePrivacyDlpV2beta1ListRootCategoriesResponse": {
+ "description": "Response for ListRootCategories request.",
+ "type": "object",
"properties": {
"categories": {
- "description": "List of all into type categories supported by the API.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
},
- "type": "array"
+ "type": "array",
+ "description": "List of all into type categories supported by the API."
}
},
- "id": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse",
- "description": "Response for ListRootCategories request.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
},
"GooglePrivacyDlpV2beta1Finding": {
"description": "Container structure describing a single finding within a string or image.",
@@ -200,8 +907,8 @@
"$ref": "GooglePrivacyDlpV2beta1InfoType"
},
"location": {
- "description": "Location of the info found.",
- "$ref": "GooglePrivacyDlpV2beta1Location"
+ "$ref": "GooglePrivacyDlpV2beta1Location",
+ "description": "Location of the info found."
},
"quote": {
"description": "The specific string that may be potentially sensitive info.",
@@ -246,11 +953,11 @@
"type": "object",
"properties": {
"operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleLongrunningOperation"
},
- "type": "array",
- "description": "A list of operations that matches the specified filter in the request."
+ "type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -283,25 +990,25 @@
"id": "GooglePrivacyDlpV2beta1FileSet"
},
"GoogleProtobufEmpty": {
- "id": "GoogleProtobufEmpty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "GoogleProtobufEmpty"
},
"GooglePrivacyDlpV2beta1ListInspectFindingsResponse": {
- "description": "Response to the ListInspectFindings request.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more results that match the\nrequest; this value should be passed in a new `ListInspectFindingsRequest`.",
+ "type": "string"
+ },
"result": {
"$ref": "GooglePrivacyDlpV2beta1InspectResult",
"description": "The results."
- },
- "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`."
}
},
- "id": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
+ "id": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse",
+ "description": "Response to the ListInspectFindings request."
},
"GooglePrivacyDlpV2beta1TableLocation": {
"description": "Location of a finding within a `ContentItem.Table`.",
@@ -316,27 +1023,29 @@
"id": "GooglePrivacyDlpV2beta1TableLocation"
},
"GooglePrivacyDlpV2beta1DatastoreKey": {
- "description": "Record key for a finding in Cloud Datastore.",
"type": "object",
"properties": {
"entityKey": {
- "$ref": "GooglePrivacyDlpV2beta1Key",
- "description": "Datastore entity key."
+ "description": "Datastore entity key.",
+ "$ref": "GooglePrivacyDlpV2beta1Key"
}
},
- "id": "GooglePrivacyDlpV2beta1DatastoreKey"
+ "id": "GooglePrivacyDlpV2beta1DatastoreKey",
+ "description": "Record key for a finding in Cloud Datastore."
},
"GooglePrivacyDlpV2beta1CloudStorageOptions": {
- "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
"type": "object",
"properties": {
"fileSet": {
"$ref": "GooglePrivacyDlpV2beta1FileSet"
}
},
- "id": "GooglePrivacyDlpV2beta1CloudStorageOptions"
+ "id": "GooglePrivacyDlpV2beta1CloudStorageOptions",
+ "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket."
},
"GooglePrivacyDlpV2beta1RecordKey": {
+ "description": "Message for a unique key indicating a record that contains a finding.",
+ "type": "object",
"properties": {
"cloudStorageKey": {
"$ref": "GooglePrivacyDlpV2beta1CloudStorageKey"
@@ -345,9 +1054,7 @@
"$ref": "GooglePrivacyDlpV2beta1DatastoreKey"
}
},
- "id": "GooglePrivacyDlpV2beta1RecordKey",
- "description": "Message for a unique key indicating a record that contains a finding.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1RecordKey"
},
"GooglePrivacyDlpV2beta1CloudStoragePath": {
"description": "A location in Cloud Storage.",
@@ -372,7 +1079,6 @@
"id": "GooglePrivacyDlpV2beta1InspectOperationResult"
},
"GooglePrivacyDlpV2beta1Range": {
- "id": "GooglePrivacyDlpV2beta1Range",
"description": "Generic half-open interval [start, end)",
"type": "object",
"properties": {
@@ -386,16 +1092,22 @@
"description": "Index of the first character of the range (inclusive).",
"type": "string"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1Range"
},
"GoogleTypeTimeOfDay": {
"description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
"type": "object",
"properties": {
- "hours": {
+ "minutes": {
+ "type": "integer",
"format": "int32",
- "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
- "type": "integer"
+ "description": "Minutes of hour of day. Must be from 0 to 59."
+ },
+ "hours": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time."
},
"nanos": {
"format": "int32",
@@ -406,11 +1118,6 @@
"format": "int32",
"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
"type": "integer"
- },
- "minutes": {
- "format": "int32",
- "description": "Minutes of hour of day. Must be from 0 to 59.",
- "type": "integer"
}
},
"id": "GoogleTypeTimeOfDay"
@@ -424,11 +1131,11 @@
"type": "boolean"
},
"findings": {
+ "description": "List of findings for an item.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Finding"
},
- "type": "array",
- "description": "List of findings for an item."
+ "type": "array"
}
},
"id": "GooglePrivacyDlpV2beta1InspectResult"
@@ -441,9 +1148,9 @@
"type": "integer"
},
"top": {
+ "type": "integer",
"format": "int32",
- "description": "Top coordinate of the bounding box. (0,0) is upper left.",
- "type": "integer"
+ "description": "Top coordinate of the bounding box. (0,0) is upper left."
},
"left": {
"format": "int32",
@@ -451,9 +1158,9 @@
"type": "integer"
},
"width": {
+ "type": "integer",
"format": "int32",
- "description": "Width of the bounding box in pixels.",
- "type": "integer"
+ "description": "Width of the bounding box in pixels."
}
},
"id": "GooglePrivacyDlpV2beta1ImageLocation",
@@ -469,12 +1176,12 @@
"description": "Google Cloud Storage options specification."
},
"datastoreOptions": {
- "description": "Google Cloud Datastore options specification.",
- "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions"
+ "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions",
+ "description": "Google Cloud Datastore options specification."
},
"bigQueryOptions": {
- "description": "BigQuery options specification.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions"
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions",
+ "description": "BigQuery options specification."
}
},
"id": "GooglePrivacyDlpV2beta1StorageConfig"
@@ -503,19 +1210,8 @@
},
"id": "GooglePrivacyDlpV2beta1ContentItem"
},
- "GooglePrivacyDlpV2beta1OperationConfig": {
- "description": "Additional configuration for inspect long running operations.",
- "type": "object",
- "properties": {
- "maxItemFindings": {
- "format": "int64",
- "description": "Max number of findings per file, Datastore entity, or database row.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1OperationConfig"
- },
"GooglePrivacyDlpV2beta1BigQueryOptions": {
+ "description": "Options defining BigQuery table and row identifiers.",
"type": "object",
"properties": {
"identifyingFields": {
@@ -530,8 +1226,19 @@
"description": "Complete BigQuery table reference."
}
},
- "id": "GooglePrivacyDlpV2beta1BigQueryOptions",
- "description": "Options defining BigQuery table and row identifiers."
+ "id": "GooglePrivacyDlpV2beta1BigQueryOptions"
+ },
+ "GooglePrivacyDlpV2beta1OperationConfig": {
+ "description": "Additional configuration for inspect long running operations.",
+ "type": "object",
+ "properties": {
+ "maxItemFindings": {
+ "format": "int64",
+ "description": "Max number of findings per file, Datastore entity, or database row.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1OperationConfig"
},
"GooglePrivacyDlpV2beta1ReplaceConfig": {
"type": "object",
@@ -548,14 +1255,13 @@
"id": "GooglePrivacyDlpV2beta1ReplaceConfig"
},
"GooglePrivacyDlpV2beta1Color": {
- "id": "GooglePrivacyDlpV2beta1Color",
"description": "Represents a color in the RGB color space.",
"type": "object",
"properties": {
"red": {
- "type": "number",
"format": "float",
- "description": "The amount of red in the color as a value in the interval [0, 1]."
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "type": "number"
},
"blue": {
"type": "number",
@@ -563,11 +1269,12 @@
"description": "The amount of blue in the color as a value in the interval [0, 1]."
},
"green": {
+ "type": "number",
"format": "float",
- "description": "The amount of green in the color as a value in the interval [0, 1].",
- "type": "number"
+ "description": "The amount of green in the color as a value in the interval [0, 1]."
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1Color"
},
"GooglePrivacyDlpV2beta1Table": {
"description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.",
@@ -597,9 +1304,9 @@
"$ref": "GooglePrivacyDlpV2beta1InfoType"
},
"maxFindings": {
+ "type": "integer",
"format": "int32",
- "description": "Max findings limit for the given infoType.",
- "type": "integer"
+ "description": "Max findings limit for the given infoType."
}
},
"id": "GooglePrivacyDlpV2beta1InfoTypeLimit"
@@ -619,14 +1326,15 @@
"id": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
},
"GooglePrivacyDlpV2beta1Value": {
+ "description": "Set of primitive values supported by the system.",
"type": "object",
"properties": {
"timeValue": {
"$ref": "GoogleTypeTimeOfDay"
},
"integerValue": {
- "type": "string",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"stringValue": {
"type": "string"
@@ -646,24 +1354,23 @@
"type": "number"
}
},
- "id": "GooglePrivacyDlpV2beta1Value",
- "description": "Set of primitive values supported by the system."
+ "id": "GooglePrivacyDlpV2beta1Value"
},
"GooglePrivacyDlpV2beta1CloudStorageKey": {
+ "id": "GooglePrivacyDlpV2beta1CloudStorageKey",
"description": "Record key for a finding in a Cloud Storage file.",
"type": "object",
"properties": {
"filePath": {
- "description": "Path to the file.",
- "type": "string"
+ "type": "string",
+ "description": "Path to the file."
},
"startOffset": {
"format": "int64",
"description": "Byte offset of the referenced data in the file.",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1CloudStorageKey"
+ }
},
"GooglePrivacyDlpV2beta1PartitionId": {
"description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
@@ -695,359 +1402,43 @@
"description": "Results of inspecting a list of items."
},
"GooglePrivacyDlpV2beta1RedactContentRequest": {
+ "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.",
"type": "object",
"properties": {
+ "replaceConfigs": {
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ReplaceConfig"
+ },
+ "type": "array",
+ "description": "The strings to replace findings text findings with. Must specify at least\none of these or one ImageRedactionConfig if redacting images."
+ },
+ "imageRedactionConfigs": {
+ "description": "The configuration for specifying what content to redact from images.",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
+ },
+ "type": "array"
+ },
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "Configuration for the inspector."
+ },
"items": {
"description": "The list of items to inspect. Up to 100 are allowed per request.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1ContentItem"
},
"type": "array"
- },
- "replaceConfigs": {
- "description": "The strings to replace findings text findings with. Must specify at least\none of these or one ImageRedactionConfig if redacting images.",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ReplaceConfig"
- },
- "type": "array"
- },
- "imageRedactionConfigs": {
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
- },
- "type": "array",
- "description": "The configuration for specifying what content to redact from images."
- },
- "inspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "Configuration for the inspector."
}
},
- "id": "GooglePrivacyDlpV2beta1RedactContentRequest",
- "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content."
- },
- "GooglePrivacyDlpV2beta1FieldId": {
- "description": "General identifier of a data field in a storage service.",
- "type": "object",
- "properties": {
- "columnName": {
- "description": "Name describing the field.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1FieldId"
- },
- "GooglePrivacyDlpV2beta1DatastoreOptions": {
- "description": "Options defining a data set within Google Cloud Datastore.",
- "type": "object",
- "properties": {
- "partitionId": {
- "$ref": "GooglePrivacyDlpV2beta1PartitionId",
- "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty."
- },
- "projection": {
- "description": "Properties to scan. If none are specified, all properties will be scanned\nby default.",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1Projection"
- },
- "type": "array"
- },
- "kind": {
- "description": "The kind to process.",
- "$ref": "GooglePrivacyDlpV2beta1KindExpression"
- }
- },
- "id": "GooglePrivacyDlpV2beta1DatastoreOptions"
- },
- "GoogleLongrunningCancelOperationRequest": {
- "properties": {},
- "id": "GoogleLongrunningCancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1InspectConfig": {
- "properties": {
- "infoTypes": {
- "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
- },
- "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"
- },
- "excludeTypes": {
- "description": "When true, excludes type information of the findings.",
- "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 returns findings equal or above this threshold.",
- "type": "string"
- },
- "infoTypeLimits": {
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1InfoTypeLimit"
- },
- "type": "array",
- "description": "Configuration of findings limit given for specified info types."
- },
- "maxFindings": {
- "format": "int32",
- "description": "Limits the number of findings per content item or long running operation.",
- "type": "integer"
- }
- },
- "id": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1Projection": {
- "description": "A representation of a Datastore property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "description": "The property to project.",
- "$ref": "GooglePrivacyDlpV2beta1PropertyReference"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Projection"
- },
- "GooglePrivacyDlpV2beta1CreateInspectOperationRequest": {
- "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
- "type": "object",
- "properties": {
- "inspectConfig": {
- "description": "Configuration for the inspector.",
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
- },
- "storageConfig": {
- "description": "Specification of the data set to process.",
- "$ref": "GooglePrivacyDlpV2beta1StorageConfig"
- },
- "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\u003etimestamp\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\u003cbr/\u003e\n\u003cp\u003eFor BigQuery the next columns are: \u003cli\u003erow_number \u003cli\u003eproject_id\n\u003cli\u003edataset_id \u003cli\u003etable_id",
- "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
- },
- "operationConfig": {
- "$ref": "GooglePrivacyDlpV2beta1OperationConfig",
- "description": "Additional configuration settings for long running operations."
- }
- },
- "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
- },
- "GooglePrivacyDlpV2beta1Key": {
- "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": "GooglePrivacyDlpV2beta1PathElement"
- },
- "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": "GooglePrivacyDlpV2beta1PartitionId"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Key",
- "description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1InspectContentRequest": {
- "description": "Request to search for potentially sensitive info in a list of items.",
- "type": "object",
- "properties": {
- "inspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "Configuration for the inspector."
- },
- "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": "GooglePrivacyDlpV2beta1ContentItem"
- },
- "type": "array"
- }
- },
- "id": "GooglePrivacyDlpV2beta1InspectContentRequest"
- },
- "GoogleTypeDate": {
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object",
- "properties": {
- "day": {
- "format": "int32",
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
- "type": "integer"
- },
- "year": {
- "format": "int32",
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "type": "integer"
- },
- "month": {
- "type": "integer",
- "format": "int32",
- "description": "Month of year. Must be from 1 to 12."
- }
- },
- "id": "GoogleTypeDate"
- },
- "GooglePrivacyDlpV2beta1RedactContentResponse": {
- "description": "Results of redacting a list of items.",
- "type": "object",
- "properties": {
- "items": {
- "description": "The redacted content.",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ContentItem"
- },
- "type": "array"
- }
- },
- "id": "GooglePrivacyDlpV2beta1RedactContentResponse"
- },
- "GooglePrivacyDlpV2beta1ImageRedactionConfig": {
- "type": "object",
- "properties": {
- "redactionColor": {
- "$ref": "GooglePrivacyDlpV2beta1Color",
- "description": "The color to use when redacting content from an image. If not specified,\nthe default is black."
- },
- "redactAllText": {
- "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.",
- "type": "boolean"
- },
- "infoType": {
- "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig.",
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
- }
- },
- "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig",
- "description": "Configuration for determing how redaction of images should occur."
- },
- "GooglePrivacyDlpV2beta1InfoTypeStatistics": {
- "description": "Statistics regarding a specific InfoType.",
- "type": "object",
- "properties": {
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "The type of finding this stat is for."
- },
- "count": {
- "type": "string",
- "format": "int64",
- "description": "Number of findings for this info type."
- }
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
- },
- "GooglePrivacyDlpV2beta1PropertyReference": {
- "properties": {
- "name": {
- "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1PropertyReference",
- "description": "A reference to a property relative to the Datastore kind expressions.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1Location": {
- "type": "object",
- "properties": {
- "codepointRange": {
- "$ref": "GooglePrivacyDlpV2beta1Range",
- "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8."
- },
- "fieldId": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Field id of the field containing the finding."
- },
- "imageBoxes": {
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ImageLocation"
- },
- "type": "array",
- "description": "Location within an image's pixels."
- },
- "byteRange": {
- "description": "Zero-based byte offsets within a content item.",
- "$ref": "GooglePrivacyDlpV2beta1Range"
- },
- "recordKey": {
- "description": "Key of the finding.",
- "$ref": "GooglePrivacyDlpV2beta1RecordKey"
- },
- "tableLocation": {
- "description": "Location within a `ContentItem.Table`.",
- "$ref": "GooglePrivacyDlpV2beta1TableLocation"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Location",
- "description": "Specifies the location of a finding within its source item."
- },
- "GooglePrivacyDlpV2beta1InfoTypeDescription": {
- "description": "Info type description.",
- "type": "object",
- "properties": {
- "categories": {
- "description": "List of categories this info type belongs to.",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
- },
- "type": "array"
- },
- "name": {
- "description": "Internal name of the info type.",
- "type": "string"
- },
- "displayName": {
- "description": "Human readable form of the info type name.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeDescription"
- },
- "GooglePrivacyDlpV2beta1OutputStorageConfig": {
- "description": "Cloud repository for storing output.",
- "type": "object",
- "properties": {
- "table": {
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
- "description": "Store findings in a new table in the dataset."
- },
- "storagePath": {
- "$ref": "GooglePrivacyDlpV2beta1CloudStoragePath",
- "description": "The path to a Google Cloud Storage location to store output."
- }
- },
- "id": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ "id": "GooglePrivacyDlpV2beta1RedactContentRequest"
}
},
- "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": "DLP",
"auth": {
"oauth2": {
@@ -1063,396 +1454,5 @@
"name": "dlp",
"batchPath": "batch",
"title": "DLP API",
- "ownerName": "Google",
- "resources": {
- "inspect": {
- "resources": {
- "results": {
- "resources": {
- "findings": {
- "methods": {
- "list": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "Restricts 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"
- },
- "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": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Maximum number of results to return.\nIf 0, the implementation selects a reasonable value."
- }
- },
- "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."
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "create": {
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
- },
- "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository.",
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v2beta1/inspect/operations",
- "id": "dlp.inspect.operations.create",
- "path": "v2beta1/inspect/operations"
- },
- "cancel": {
- "request": {
- "$ref": "GoogleLongrunningCancelOperationRequest"
- },
- "description": "Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^inspect/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel",
- "id": "dlp.inspect.operations.cancel",
- "path": "v2beta1/{+name}:cancel"
- },
- "delete": {
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "type": "string",
- "required": true,
- "pattern": "^inspect/operations/[^/]+$"
- }
- },
- "flatPath": "v2beta1/inspect/operations/{operationsId}",
- "id": "dlp.inspect.operations.delete",
- "path": "v2beta1/{+name}"
- },
- "get": {
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^inspect/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/operations/{operationsId}",
- "id": "dlp.inspect.operations.get",
- "path": "v2beta1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "list": {
- "response": {
- "$ref": "GoogleLongrunningListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "pattern": "^inspect/operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The list page size. The max allowed value is 256 and default is 100.",
- "type": "integer"
- },
- "filter": {
- "description": "This parameter supports filtering by done, ie done=true or done=false.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/operations",
- "id": "dlp.inspect.operations.list",
- "path": "v2beta1/{+name}",
- "description": "Fetch the list of long running operations."
- }
- }
- }
- }
- },
- "rootCategories": {
- "methods": {
- "list": {
- "description": "Returns the list of root categories of sensitive information.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "languageCode": {
- "location": "query",
- "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/rootCategories",
- "id": "dlp.rootCategories.list",
- "path": "v2beta1/rootCategories"
- }
- },
- "resources": {
- "infoTypes": {
- "methods": {
- "list": {
- "description": "Returns sensitive information types for given category.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
- },
- "parameterOrder": [
- "category"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "category": {
- "pattern": "^[^/]+$",
- "location": "path",
- "description": "Category name as returned by ListRootCategories.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes",
- "id": "dlp.rootCategories.infoTypes.list",
- "path": "v2beta1/rootCategories/{+category}/infoTypes"
- }
- }
- }
- }
- },
- "content": {
- "methods": {
- "redact": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/content:redact",
- "path": "v2beta1/content:redact",
- "id": "dlp.content.redact",
- "description": "Redacts potentially sensitive info from a list of strings.\nThis method has limits on input size, processing time, and output size.",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1RedactContentRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1RedactContentResponse"
- }
- },
- "inspect": {
- "id": "dlp.content.inspect",
- "path": "v2beta1/content:inspect",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1InspectContentRequest"
- },
- "description": "Finds potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1InspectContentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v2beta1/content:inspect"
- }
- }
- }
- },
- "parameters": {
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "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"
- ]
- }
- },
- "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": ""
+ "ownerName": "Google"
}
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
index dc65521..213cab1 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
@@ -1,363 +1,41 @@
{
- "ownerName": "Google",
- "resources": {
- "shortLinks": {
- "methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "CreateShortDynamicLinkResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {},
- "flatPath": "v1/shortLinks",
- "path": "v1/shortLinks",
- "id": "firebasedynamiclinks.shortLinks.create",
- "request": {
- "$ref": "CreateShortDynamicLinkRequest"
- },
- "description": "Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project."
- }
- }
- },
- "v1": {
- "methods": {
- "getLinkStats": {
- "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.",
- "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"
- }
- },
- "flatPath": "v1/{dynamicLink}/linkStats",
- "id": "firebasedynamiclinks.getLinkStats",
- "path": "v1/{dynamicLink}/linkStats"
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "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.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "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": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
- "servicePath": "",
- "description": "Programmatically creates and manages Firebase Dynamic Links.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "documentationLink": "https://firebase.google.com/docs/dynamic-links/",
- "revision": "20170819",
- "id": "firebasedynamiclinks:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CreateShortDynamicLinkResponse": {
- "properties": {
- "warning": {
- "description": "Information about potential warnings on link creation.",
- "items": {
- "$ref": "DynamicLinkWarning"
- },
- "type": "array"
- },
- "shortLink": {
- "description": "Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz",
- "type": "string"
- },
- "previewLink": {
- "description": "Preivew link to show the link flow chart.",
- "type": "string"
- }
- },
- "id": "CreateShortDynamicLinkResponse",
- "description": "Response to create a short Dynamic Link.",
- "type": "object"
- },
- "Suffix": {
- "description": "Short Dynamic Link suffix.",
+ "AndroidInfo": {
+ "description": "Android related attributes to the Dynamic Link.",
"type": "object",
"properties": {
- "option": {
- "enumDescriptions": [
- "The suffix option is not specified, performs as NOT_GUESSABLE .",
- "Short Dynamic Link suffix is a base62 [0-9A-Za-z] encoded string of\na random generated 96 bit random number, which has a length of 17 chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guessing and crawling short Dynamic Links\nthat contain personal identifiable information.",
- "Short Dynamic Link suffix is a base62 [0-9A-Za-z] string starting with a\nlength of 4 chars. the length will increase when all the space is\noccupied."
- ],
- "enum": [
- "OPTION_UNSPECIFIED",
- "UNGUESSABLE",
- "SHORT"
- ],
- "description": "Suffix option.",
+ "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": "Suffix"
- },
- "GooglePlayAnalytics": {
- "properties": {
- "utmMedium": {
- "description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
- "type": "string"
- },
- "utmTerm": {
- "description": "Campaign term; used with paid search to supply the keywords for ads.",
- "type": "string"
- },
- "utmSource": {
- "description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.",
- "type": "string"
- },
- "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",
- "description": "Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)",
- "type": "object"
- },
- "DynamicLinkInfo": {
- "description": "Information about a Dynamic Link.",
- "type": "object",
- "properties": {
- "navigationInfo": {
- "$ref": "NavigationInfo",
- "description": "Information of navigation behavior of a Firebase Dynamic Links."
- },
- "analyticsInfo": {
- "$ref": "AnalyticsInfo",
- "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
- },
- "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"
- },
- "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": {
- "$ref": "IosInfo",
- "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
- },
- "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/create-manually).",
- "$ref": "AndroidInfo"
- }
- },
- "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"
- },
- "SocialMetaTagInfo": {
- "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
- "type": "object",
- "properties": {
- "socialImageLink": {
- "description": "An image url string. Optional.",
- "type": "string"
- },
- "socialTitle": {
- "description": "Title to be displayed. Optional.",
- "type": "string"
- },
- "socialDescription": {
- "description": "A short description of the link. Optional.",
- "type": "string"
- }
- },
- "id": "SocialMetaTagInfo"
- },
- "DynamicLinkStats": {
- "properties": {
- "linkEventStats": {
- "description": "Dynamic Link event stats.",
- "items": {
- "$ref": "DynamicLinkEventStat"
- },
- "type": "array"
- }
- },
- "id": "DynamicLinkStats",
- "description": "Analytics stats of a Dynamic Link for a given timeframe.",
- "type": "object"
+ "id": "AndroidInfo"
},
"DynamicLinkWarning": {
"properties": {
+ "warningMessage": {
+ "description": "The warning message to help developers improve their requests.",
+ "type": "string"
+ },
+ "warningDocumentLink": {
+ "description": "The document describing the warning, and helps resolve.",
+ "type": "string"
+ },
"warningCode": {
- "enum": [
- "CODE_UNSPECIFIED",
- "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME",
- "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION",
- "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION",
- "NOT_URI_ANDROID_LINK",
- "UNNECESSARY_ANDROID_LINK",
- "NOT_URI_ANDROID_FALLBACK_LINK",
- "BAD_URI_SCHEME_ANDROID_FALLBACK_LINK",
- "NOT_IN_PROJECT_IOS_BUNDLE_ID",
- "NOT_IN_PROJECT_IPAD_BUNDLE_ID",
- "UNNECESSARY_IOS_URL_SCHEME",
- "NOT_NUMERIC_IOS_APP_STORE_ID",
- "UNNECESSARY_IOS_APP_STORE_ID",
- "NOT_URI_IOS_FALLBACK_LINK",
- "BAD_URI_SCHEME_IOS_FALLBACK_LINK",
- "NOT_URI_IPAD_FALLBACK_LINK",
- "BAD_URI_SCHEME_IPAD_FALLBACK_LINK",
- "BAD_DEBUG_PARAM",
- "BAD_AD_PARAM",
- "DEPRECATED_PARAM",
- "UNRECOGNIZED_PARAM",
- "TOO_LONG_PARAM",
- "NOT_URI_SOCIAL_IMAGE_LINK",
- "BAD_URI_SCHEME_SOCIAL_IMAGE_LINK",
- "NOT_URI_SOCIAL_URL",
- "BAD_URI_SCHEME_SOCIAL_URL",
- "LINK_LENGTH_TOO_LONG",
- "LINK_WITH_FRAGMENTS",
- "NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID"
- ],
- "description": "The warning code.",
"type": "string",
"enumDescriptions": [
"Unknown code.",
@@ -389,54 +67,69 @@
"Dynamic Link URL length is too long.",
"Dynamic Link URL contains fragments.",
"The iOS bundle ID does not match with the given iOS store ID."
- ]
- },
- "warningMessage": {
- "description": "The warning message to help developers improve their requests.",
- "type": "string"
- },
- "warningDocumentLink": {
- "description": "The document describing the warning, and helps resolve.",
- "type": "string"
+ ],
+ "enum": [
+ "CODE_UNSPECIFIED",
+ "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME",
+ "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION",
+ "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION",
+ "NOT_URI_ANDROID_LINK",
+ "UNNECESSARY_ANDROID_LINK",
+ "NOT_URI_ANDROID_FALLBACK_LINK",
+ "BAD_URI_SCHEME_ANDROID_FALLBACK_LINK",
+ "NOT_IN_PROJECT_IOS_BUNDLE_ID",
+ "NOT_IN_PROJECT_IPAD_BUNDLE_ID",
+ "UNNECESSARY_IOS_URL_SCHEME",
+ "NOT_NUMERIC_IOS_APP_STORE_ID",
+ "UNNECESSARY_IOS_APP_STORE_ID",
+ "NOT_URI_IOS_FALLBACK_LINK",
+ "BAD_URI_SCHEME_IOS_FALLBACK_LINK",
+ "NOT_URI_IPAD_FALLBACK_LINK",
+ "BAD_URI_SCHEME_IPAD_FALLBACK_LINK",
+ "BAD_DEBUG_PARAM",
+ "BAD_AD_PARAM",
+ "DEPRECATED_PARAM",
+ "UNRECOGNIZED_PARAM",
+ "TOO_LONG_PARAM",
+ "NOT_URI_SOCIAL_IMAGE_LINK",
+ "BAD_URI_SCHEME_SOCIAL_IMAGE_LINK",
+ "NOT_URI_SOCIAL_URL",
+ "BAD_URI_SCHEME_SOCIAL_URL",
+ "LINK_LENGTH_TOO_LONG",
+ "LINK_WITH_FRAGMENTS",
+ "NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID"
+ ],
+ "description": "The warning code."
}
},
"id": "DynamicLinkWarning",
"description": "Dynamic Links warning messages.",
"type": "object"
},
- "AndroidInfo": {
- "description": "Android related attributes to the Dynamic Link.",
- "type": "object",
+ "DynamicLinkStats": {
"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": {
+ "type": "array",
+ "items": {
+ "$ref": "DynamicLinkEventStat"
+ },
+ "description": "Dynamic Link event stats."
}
},
- "id": "AndroidInfo"
+ "id": "DynamicLinkStats",
+ "description": "Analytics stats of a Dynamic Link for a given timeframe.",
+ "type": "object"
},
"NavigationInfo": {
+ "description": "Information of navigation behavior.",
+ "type": "object",
"properties": {
"enableForcedRedirect": {
"description": "If this option is on, FDL click will be forced to redirect rather than\nshow an interstitial page.",
"type": "boolean"
}
},
- "id": "NavigationInfo",
- "description": "Information of navigation behavior.",
- "type": "object"
+ "id": "NavigationInfo"
},
"IosInfo": {
"description": "iOS related attributes to the Dynamic Link..",
@@ -463,13 +156,14 @@
"type": "string"
},
"iosBundleId": {
- "description": "iOS bundle ID of the app.",
- "type": "string"
+ "type": "string",
+ "description": "iOS bundle ID of the app."
}
},
"id": "IosInfo"
},
"AnalyticsInfo": {
+ "id": "AnalyticsInfo",
"description": "Tracking parameters supported by Dynamic Link.",
"type": "object",
"properties": {
@@ -478,14 +172,19 @@
"description": "iTunes Connect App Analytics."
},
"googlePlayAnalytics": {
- "description": "Google Play Campaign Measurements.",
- "$ref": "GooglePlayAnalytics"
+ "$ref": "GooglePlayAnalytics",
+ "description": "Google Play Campaign Measurements."
}
- },
- "id": "AnalyticsInfo"
+ }
},
"CreateShortDynamicLinkRequest": {
+ "description": "Request to create a short Dynamic Link.",
+ "type": "object",
"properties": {
+ "dynamicLinkInfo": {
+ "$ref": "DynamicLinkInfo",
+ "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
+ },
"longDynamicLink": {
"description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
"type": "string"
@@ -493,27 +192,13 @@
"suffix": {
"$ref": "Suffix",
"description": "Short Dynamic Link suffix. Optional."
- },
- "dynamicLinkInfo": {
- "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
- "$ref": "DynamicLinkInfo"
}
},
- "id": "CreateShortDynamicLinkRequest",
- "description": "Request to create a short Dynamic Link.",
- "type": "object"
+ "id": "CreateShortDynamicLinkRequest"
},
"DynamicLinkEventStat": {
- "description": "Dynamic Link event stat.",
- "type": "object",
"properties": {
"platform": {
- "enum": [
- "DYNAMIC_LINK_PLATFORM_UNSPECIFIED",
- "ANDROID",
- "IOS",
- "DESKTOP"
- ],
"description": "Requested platform.",
"type": "string",
"enumDescriptions": [
@@ -521,22 +206,20 @@
"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"
]
},
"count": {
- "format": "int64",
"description": "The number of times this event occurred.",
+ "format": "int64",
"type": "string"
},
"event": {
- "enumDescriptions": [
- "Unspecified type.",
- "Indicates that an FDL is clicked by users.",
- "Indicates that an FDL redirects users to fallback link.",
- "Indicates that an FDL triggers an app install from Play store, currently\nit's impossible to get stats from App store.",
- "Indicates that the app is opened for the first time after an install\ntriggered by FDLs",
- "Indicates that the app is opened via an FDL for non-first time."
- ],
"enum": [
"DYNAMIC_LINK_EVENT_UNSPECIFIED",
"CLICK",
@@ -546,17 +229,178 @@
"APP_RE_OPEN"
],
"description": "Link event.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified type.",
+ "Indicates that an FDL is clicked by users.",
+ "Indicates that an FDL redirects users to fallback link.",
+ "Indicates that an FDL triggers an app install from Play store, currently\nit's impossible to get stats from App store.",
+ "Indicates that the app is opened for the first time after an install\ntriggered by FDLs",
+ "Indicates that the app is opened via an FDL for non-first time."
+ ]
+ }
+ },
+ "id": "DynamicLinkEventStat",
+ "description": "Dynamic Link event stat.",
+ "type": "object"
+ },
+ "CreateShortDynamicLinkResponse": {
+ "description": "Response to create a short Dynamic Link.",
+ "type": "object",
+ "properties": {
+ "shortLink": {
+ "description": "Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz",
+ "type": "string"
+ },
+ "previewLink": {
+ "type": "string",
+ "description": "Preivew link to show the link flow chart."
+ },
+ "warning": {
+ "description": "Information about potential warnings on link creation.",
+ "type": "array",
+ "items": {
+ "$ref": "DynamicLinkWarning"
+ }
+ }
+ },
+ "id": "CreateShortDynamicLinkResponse"
+ },
+ "Suffix": {
+ "type": "object",
+ "properties": {
+ "option": {
+ "type": "string",
+ "enumDescriptions": [
+ "The suffix option is not specified, performs as NOT_GUESSABLE .",
+ "Short Dynamic Link suffix is a base62 [0-9A-Za-z] encoded string of\na random generated 96 bit random number, which has a length of 17 chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guessing and crawling short Dynamic Links\nthat contain personal identifiable information.",
+ "Short Dynamic Link suffix is a base62 [0-9A-Za-z] string starting with a\nlength of 4 chars. the length will increase when all the space is\noccupied."
+ ],
+ "enum": [
+ "OPTION_UNSPECIFIED",
+ "UNGUESSABLE",
+ "SHORT"
+ ],
+ "description": "Suffix option."
+ }
+ },
+ "id": "Suffix",
+ "description": "Short Dynamic Link suffix."
+ },
+ "GooglePlayAnalytics": {
+ "description": "Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)",
+ "type": "object",
+ "properties": {
+ "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": {
+ "type": "string",
+ "description": "Campaign content; used for A/B testing and content-targeted ads to\ndifferentiate ads or links that point to the same URL."
+ },
+ "utmMedium": {
+ "description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
"type": "string"
}
},
- "id": "DynamicLinkEventStat"
+ "id": "GooglePlayAnalytics"
+ },
+ "DynamicLinkInfo": {
+ "properties": {
+ "dynamicLinkDomain": {
+ "type": "string",
+ "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."
+ },
+ "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": {
+ "$ref": "IosInfo",
+ "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
+ },
+ "socialMetaTagInfo": {
+ "$ref": "SocialMetaTagInfo",
+ "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites."
+ },
+ "androidInfo": {
+ "$ref": "AndroidInfo",
+ "description": "Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
+ },
+ "navigationInfo": {
+ "$ref": "NavigationInfo",
+ "description": "Information of navigation behavior of a Firebase Dynamic Links."
+ },
+ "analyticsInfo": {
+ "$ref": "AnalyticsInfo",
+ "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
+ }
+ },
+ "id": "DynamicLinkInfo",
+ "description": "Information about a Dynamic Link.",
+ "type": "object"
+ },
+ "ITunesConnectAnalytics": {
+ "properties": {
+ "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"
+ },
+ "at": {
+ "description": "Affiliate token used to create affiliate-coded links.",
+ "type": "string"
+ }
+ },
+ "id": "ITunesConnectAnalytics",
+ "description": "Parameters for iTunes Connect App Analytics.",
+ "type": "object"
+ },
+ "SocialMetaTagInfo": {
+ "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
+ "type": "object",
+ "properties": {
+ "socialDescription": {
+ "description": "A short description of the link. Optional.",
+ "type": "string"
+ },
+ "socialTitle": {
+ "description": "Title to be displayed. Optional.",
+ "type": "string"
+ },
+ "socialImageLink": {
+ "description": "An image url string. Optional.",
+ "type": "string"
+ }
+ },
+ "id": "SocialMetaTagInfo"
}
},
+ "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": "Firebase Dynamic Links",
"auth": {
"oauth2": {
@@ -571,5 +415,161 @@
"ownerDomain": "google.com",
"name": "firebasedynamiclinks",
"batchPath": "batch",
- "title": "Firebase Dynamic Links API"
+ "title": "Firebase Dynamic Links API",
+ "ownerName": "Google",
+ "resources": {
+ "shortLinks": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "CreateShortDynamicLinkResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "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."
+ }
+ }
+ },
+ "v1": {
+ "methods": {
+ "getLinkStats": {
+ "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.",
+ "response": {
+ "$ref": "DynamicLinkStats"
+ },
+ "parameterOrder": [
+ "dynamicLink"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "durationDays": {
+ "location": "query",
+ "description": "The span of time requested in days.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dynamicLink": {
+ "location": "path",
+ "description": "Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "flatPath": "v1/{dynamicLink}/linkStats",
+ "path": "v1/{dynamicLink}/linkStats",
+ "id": "firebasedynamiclinks.getLinkStats"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Programmatically creates and manages Firebase Dynamic Links.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170823",
+ "documentationLink": "https://firebase.google.com/docs/dynamic-links/",
+ "id": "firebasedynamiclinks:v1"
}
diff --git a/firebaserules/v1/firebaserules-api.json b/firebaserules/v1/firebaserules-api.json
index 75b9b46..6efc700 100644
--- a/firebaserules/v1/firebaserules-api.json
+++ b/firebaserules/v1/firebaserules-api.json
@@ -1,591 +1,21 @@
{
- "resources": {
- "projects": {
- "resources": {
- "rulesets": {
- "methods": {
- "create": {
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Ruleset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {
- "name": {
- "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/rulesets"
- },
- "delete": {
- "path": "v1/{+name}",
- "id": "firebaserules.projects.rulesets.delete",
- "description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/rulesets/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}"
- },
- "list": {
- "description": "List `Ruleset` metadata only and optionally filter the results by `Ruleset`\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListRulesetsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
- "parameters": {
- "filter": {
- "description": "`Ruleset` filter. The list method supports filters with restrictions on\n`Ruleset.name`.\n\nFilters on `Ruleset.create_time` should use the `date` function which\nparses strings that conform to the RFC 3339 date/time specifications.\n\nExample: `create_time \u003e date(\"2017-01-01\") AND name=UUID-*`",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Next page token for loading the next batch of `Ruleset` instances.",
- "type": "string"
- },
- "name": {
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/rulesets",
- "path": "v1/{+name}/rulesets",
- "id": "firebaserules.projects.rulesets.list"
- },
- "get": {
- "description": "Get a `Ruleset` by name including the full `Source` contents.",
- "response": {
- "$ref": "Ruleset"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name for the ruleset to get.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
- "type": "string",
- "required": true,
- "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}"
- }
- }
- },
- "releases": {
- "methods": {
- "delete": {
- "description": "Delete a `Release` by resource name.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path",
- "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "id": "firebaserules.projects.releases.delete",
- "path": "v1/{+name}"
- },
- "list": {
- "description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name, `Ruleset` name, `TestSuite` name, or any\ncombination thereof.",
- "response": {
- "$ref": "ListReleasesResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Next page token for the next batch of `Release` instances.",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load fewer\nthan `page_size` results due to the size of the output. To traverse all of\nthe releases, the caller should iterate until the `page_token` on the\nresponse is empty.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.\n\nExample 1: A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2: A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters are\nrelative to the project. Fully qualified prefixed may also be used. e.g.\n`test_suite_name=projects/foo/testsuites/uuid1`",
- "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}/releases",
- "id": "firebaserules.projects.releases.list",
- "path": "v1/{+name}/releases"
- },
- "get": {
- "description": "Get a `Release` by name.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Release"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path",
- "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.releases.get"
- },
- "update": {
- "response": {
- "$ref": "Release"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path",
- "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "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": {
- "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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/releases",
- "path": "v1/{+name}/releases",
- "id": "firebaserules.projects.releases.create"
- }
- }
- }
- },
- "methods": {
- "test": {
- "request": {
- "$ref": "TestRulesetRequest"
- },
- "description": "Test `Source` for syntactic and semantic correctness. Issues present, if\nany, will be returned to the caller with a description, severity, and\nsource location.\n\nThe test method may be executed with `Source` or a `Ruleset` name.\nPassing `Source` is useful for unit testing new rules. Passing a `Ruleset`\nname is useful for regression testing an existing rule.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.auth.uid\n && (imageName.matches('*.png$')\n || imageName.matches('*.jpg$'))\n && resource.mimeType.matches('^image/')\n }\n }",
- "response": {
- "$ref": "TestRulesetResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
- "parameters": {
- "name": {
- "description": "Tests may either provide `source` or a `Ruleset` resource name.\n\nFor tests against `source`, the resource name must refer to the project:\nFormat: `projects/{project_id}`\n\nFor tests against a `Ruleset`, this must be the `Ruleset` resource name:\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}:test",
- "id": "firebaserules.projects.test",
- "path": "v1/{+name}:test"
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://firebaserules.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
- "servicePath": "",
- "basePath": "",
- "revision": "20170807",
- "documentationLink": "https://firebase.google.com/docs/storage/security",
"id": "firebaserules:v1",
+ "documentationLink": "https://firebase.google.com/docs/storage/security",
+ "revision": "20170807",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "TestCase": {
- "properties": {
- "functionMocks": {
- "description": "Optional function mocks for service-defined functions. If not set, any\nservice defined function is expected to return an error, which may or may\nnot influence the test outcome.",
- "items": {
- "$ref": "FunctionMock"
- },
- "type": "array"
- },
- "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"
- },
- "expectation": {
- "enumDescriptions": [
- "Unspecified expectation.",
- "Expect an allowed result.",
- "Expect a denied result."
- ],
- "enum": [
- "EXPECTATION_UNSPECIFIED",
- "ALLOW",
- "DENY"
- ],
- "description": "Test expectation.",
- "type": "string"
- },
- "request": {
- "description": "Request context.\n\nThe exact format of the request context is service-dependent. See the\nappropriate service documentation for information about the supported\nfields and types on the request. Minimally, all services support the\nfollowing fields and types:\n\nRequest field | Type\n---------------|-----------------\nauth.uid | `string`\nauth.token | `map\u003cstring, string\u003e`\nheaders | `map\u003cstring, string\u003e`\nmethod | `string`\nparams | `map\u003cstring, string\u003e`\npath | `string`\ntime | `google.protobuf.Timestamp`\n\nIf the request value is not well-formed for the service, the request will\nbe rejected as an invalid argument.",
- "type": "any"
- }
- },
- "id": "TestCase",
- "description": "`TestCase` messages provide the request context and an expectation as to\nwhether the given context will be allowed or denied. Test cases may specify\nthe `request`, `resource`, and `function_mocks` to mock a function call to\na service-provided function.\n\nThe `request` object represents context present at request-time.\n\nThe `resource` is the value of the target resource as it appears in\npersistent storage before the request is executed.",
- "type": "object"
- },
- "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": {
- "format": "google-datetime",
- "description": "Time the `Ruleset` was created.\nOutput only.",
- "type": "string"
- }
- },
- "id": "Ruleset"
- },
- "TestRulesetRequest": {
- "properties": {
- "testSuite": {
- "description": "Inline `TestSuite` to run.",
- "$ref": "TestSuite"
- },
- "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"
- }
- },
- "id": "TestRulesetRequest",
- "description": "The request for FirebaseRulesService.TestRuleset.",
- "type": "object"
- },
- "Issue": {
- "properties": {
- "severity": {
- "enumDescriptions": [
- "An unspecified severity.",
- "Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
- "Warnings such as: unused variables.",
- "Errors such as: unmatched curly braces or variable redefinition."
- ],
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "DEPRECATION",
- "WARNING",
- "ERROR"
- ],
- "description": "The severity of the issue.",
- "type": "string"
- },
- "description": {
- "description": "Short error description.",
- "type": "string"
- },
- "sourcePosition": {
- "$ref": "SourcePosition",
- "description": "Position of the issue in the `Source`."
- }
- },
- "id": "Issue",
- "description": "Issues include warnings, errors, and deprecation notices.",
- "type": "object"
- },
- "FunctionCall": {
- "properties": {
- "function": {
- "description": "Name of the function invoked.",
- "type": "string"
- },
- "args": {
- "description": "The arguments that were provided to the function.",
- "items": {
- "type": "any"
- },
- "type": "array"
- }
- },
- "id": "FunctionCall",
- "description": "Represents a service-defined function call that was invoked during test\nexecution.",
- "type": "object"
- },
- "File": {
- "properties": {
- "name": {
- "description": "File name.",
- "type": "string"
- },
- "content": {
- "description": "Textual Content.",
- "type": "string"
- },
- "fingerprint": {
- "format": "byte",
- "description": "Fingerprint (e.g. github sha) associated with the `File`.",
- "type": "string"
- }
- },
- "id": "File",
- "description": "`File` containing source content.",
- "type": "object"
- },
- "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.",
- "items": {
- "$ref": "Release"
- },
- "type": "array"
- }
- },
- "id": "ListReleasesResponse"
- },
"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": {
+ "rulesetName": {
+ "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`"
+ },
"createTime": {
"format": "google-datetime",
"description": "Time the release was created.\nOutput only.",
@@ -595,17 +25,10 @@
"format": "google-datetime",
"description": "Time the release was updated.\nOutput only.",
"type": "string"
- },
- "rulesetName": {
- "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.",
- "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"
}
},
- "id": "Release"
+ "id": "Release",
+ "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`."
},
"TestRulesetResponse": {
"description": "The response for FirebaseRulesService.TestRuleset.",
@@ -628,32 +51,18 @@
},
"id": "TestRulesetResponse"
},
- "ListRulesetsResponse": {
- "description": "The response for FirebaseRulesService.ListRulesets.",
- "type": "object",
- "properties": {
- "rulesets": {
- "description": "List of `Ruleset` instances.",
- "items": {
- "$ref": "Ruleset"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
- "type": "string"
- }
- },
- "id": "ListRulesetsResponse"
- },
"TestResult": {
"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`.",
"items": {
"$ref": "FunctionCall"
},
- "type": "array"
+ "type": "array",
+ "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`."
},
"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\"]```",
@@ -663,6 +72,7 @@
"type": "array"
},
"state": {
+ "type": "string",
"enumDescriptions": [
"Test state is not set.",
"Test is a success.",
@@ -673,18 +83,31 @@
"SUCCESS",
"FAILURE"
],
- "description": "State of the test.",
- "type": "string"
- },
- "errorPosition": {
- "$ref": "SourcePosition",
- "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`"
+ "description": "State of the test."
}
},
"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"
},
+ "ListRulesetsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
+ "type": "string"
+ },
+ "rulesets": {
+ "description": "List of `Ruleset` instances.",
+ "items": {
+ "$ref": "Ruleset"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListRulesetsResponse",
+ "description": "The response for FirebaseRulesService.ListRulesets."
+ },
"Arg": {
"description": "Arg matchers for the mock function.",
"type": "object",
@@ -701,6 +124,8 @@
"id": "Arg"
},
"TestSuite": {
+ "description": "`TestSuite` is a collection of `TestCase` instances that validate the logical\ncorrectness of a `Ruleset`. The `TestSuite` may be referenced in-line within\na `TestRuleset` invocation or as part of a `Release` object as a pre-release\ncheck.",
+ "type": "object",
"properties": {
"testCases": {
"description": "Collection of test cases associated with the `TestSuite`.",
@@ -710,9 +135,7 @@
"type": "array"
}
},
- "id": "TestSuite",
- "description": "`TestSuite` is a collection of `TestCase` instances that validate the logical\ncorrectness of a `Ruleset`. The `TestSuite` may be referenced in-line within\na `TestRuleset` invocation or as part of a `Release` object as a pre-release\ncheck.",
- "type": "object"
+ "id": "TestSuite"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
@@ -721,6 +144,8 @@
"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.",
@@ -734,13 +159,11 @@
"type": "string"
},
"result": {
- "description": "The mock result of the function call.",
- "$ref": "Result"
+ "$ref": "Result",
+ "description": "The mock result of the function call."
}
},
- "id": "FunctionMock",
- "description": "Mock function definition.\n\nMocks must refer to a function declared by the target service. The type of\nthe function args and result will be inferred at test time. If either the\narg or result values are not compatible with function type declaration, the\nrequest will be considered invalid.\n\nMore than one `FunctionMock` may be provided for a given function name so\nlong as the `Arg` matchers are distinct. There may be only one function\nfor a given overload where all `Arg` values are `Arg.any_value`.",
- "type": "object"
+ "id": "FunctionMock"
},
"Source": {
"description": "`Source` is one or more `File` messages comprising a logical set of rules.",
@@ -776,9 +199,9 @@
"type": "object",
"properties": {
"column": {
+ "type": "integer",
"format": "int32",
- "description": "First column on the source line associated with the source fragment.",
- "type": "integer"
+ "description": "First column on the source line associated with the source fragment."
},
"fileName": {
"description": "Name of the `File`.",
@@ -791,6 +214,164 @@
}
},
"id": "SourcePosition"
+ },
+ "TestCase": {
+ "description": "`TestCase` messages provide the request context and an expectation as to\nwhether the given context will be allowed or denied. Test cases may specify\nthe `request`, `resource`, and `function_mocks` to mock a function call to\na service-provided function.\n\nThe `request` object represents context present at request-time.\n\nThe `resource` is the value of the target resource as it appears in\npersistent storage before the request is executed.",
+ "type": "object",
+ "properties": {
+ "functionMocks": {
+ "description": "Optional function mocks for service-defined functions. If not set, any\nservice defined function is expected to return an error, which may or may\nnot influence the test outcome.",
+ "items": {
+ "$ref": "FunctionMock"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "expectation": {
+ "enumDescriptions": [
+ "Unspecified expectation.",
+ "Expect an allowed result.",
+ "Expect a denied result."
+ ],
+ "enum": [
+ "EXPECTATION_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "Test expectation.",
+ "type": "string"
+ },
+ "request": {
+ "description": "Request context.\n\nThe exact format of the request context is service-dependent. See the\nappropriate service documentation for information about the supported\nfields and types on the request. Minimally, all services support the\nfollowing fields and types:\n\nRequest field | Type\n---------------|-----------------\nauth.uid | `string`\nauth.token | `map\u003cstring, string\u003e`\nheaders | `map\u003cstring, string\u003e`\nmethod | `string`\nparams | `map\u003cstring, string\u003e`\npath | `string`\ntime | `google.protobuf.Timestamp`\n\nIf the request value is not well-formed for the service, the request will\nbe rejected as an invalid argument.",
+ "type": "any"
+ }
+ },
+ "id": "TestCase"
+ },
+ "Issue": {
+ "id": "Issue",
+ "description": "Issues include warnings, errors, and deprecation notices.",
+ "type": "object",
+ "properties": {
+ "sourcePosition": {
+ "description": "Position of the issue in the `Source`.",
+ "$ref": "SourcePosition"
+ },
+ "severity": {
+ "enumDescriptions": [
+ "An unspecified severity.",
+ "Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
+ "Warnings such as: unused variables.",
+ "Errors such as: unmatched curly braces or variable redefinition."
+ ],
+ "enum": [
+ "SEVERITY_UNSPECIFIED",
+ "DEPRECATION",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "The severity of the issue.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "Short error description."
+ }
+ }
+ },
+ "TestRulesetRequest": {
+ "id": "TestRulesetRequest",
+ "description": "The request for FirebaseRulesService.TestRuleset.",
+ "type": "object",
+ "properties": {
+ "testSuite": {
+ "$ref": "TestSuite",
+ "description": "Inline `TestSuite` to run."
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`."
+ }
+ }
+ },
+ "Ruleset": {
+ "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "Source",
+ "description": "`Source` for the `Ruleset`."
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Time the `Ruleset` was created.\nOutput only.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "Ruleset"
+ },
+ "ListReleasesResponse": {
+ "description": "The response for FirebaseRulesService.ListReleases.",
+ "type": "object",
+ "properties": {
+ "releases": {
+ "description": "List of `Release` instances.",
+ "items": {
+ "$ref": "Release"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
+ "type": "string"
+ }
+ },
+ "id": "ListReleasesResponse"
+ },
+ "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.",
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "function": {
+ "type": "string",
+ "description": "Name of the function invoked."
+ }
+ },
+ "id": "FunctionCall"
+ },
+ "File": {
+ "description": "`File` containing source content.",
+ "type": "object",
+ "properties": {
+ "fingerprint": {
+ "format": "byte",
+ "description": "Fingerprint (e.g. github sha) associated with the `File`.",
+ "type": "string"
+ },
+ "name": {
+ "description": "File name.",
+ "type": "string"
+ },
+ "content": {
+ "type": "string",
+ "description": "Textual Content."
+ }
+ },
+ "id": "File"
}
},
"protocol": "rest",
@@ -819,5 +400,424 @@
"name": "firebaserules",
"batchPath": "batch",
"title": "Firebase Rules API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "methods": {
+ "test": {
+ "description": "Test `Source` for syntactic and semantic correctness. Issues present, if\nany, will be returned to the caller with a description, severity, and\nsource location.\n\nThe test method may be executed with `Source` or a `Ruleset` name.\nPassing `Source` is useful for unit testing new rules. Passing a `Ruleset`\nname is useful for regression testing an existing rule.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.auth.uid\n && (imageName.matches('*.png$')\n || imageName.matches('*.jpg$'))\n && resource.mimeType.matches('^image/')\n }\n }",
+ "request": {
+ "$ref": "TestRulesetRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "TestRulesetResponse"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/.+$",
+ "location": "path",
+ "description": "Tests may either provide `source` or a `Ruleset` resource name.\n\nFor tests against `source`, the resource name must refer to the project:\nFormat: `projects/{project_id}`\n\nFor tests against a `Ruleset`, this must be the `Ruleset` resource name:\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
+ "flatPath": "v1/projects/{projectsId}:test",
+ "path": "v1/{+name}:test",
+ "id": "firebaserules.projects.test"
+ }
+ },
+ "resources": {
+ "rulesets": {
+ "methods": {
+ "list": {
+ "description": "List `Ruleset` metadata only and optionally filter the results by `Ruleset`\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListRulesetsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Next page token for loading the next batch of `Ruleset` instances.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "`Ruleset` filter. The list method supports filters with restrictions on\n`Ruleset.name`.\n\nFilters on `Ruleset.create_time` should use the `date` function which\nparses strings that conform to the RFC 3339 date/time specifications.\n\nExample: `create_time \u003e date(\"2017-01-01\") AND name=UUID-*`",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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"
+ },
+ "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": {
+ "location": "path",
+ "description": "Resource name for the ruleset to get.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
+ "id": "firebaserules.projects.rulesets.get",
+ "path": "v1/{+name}"
+ },
+ "create": {
+ "response": {
+ "$ref": "Ruleset"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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": {
+ "description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
+ "id": "firebaserules.projects.rulesets.delete",
+ "path": "v1/{+name}"
+ }
+ }
+ },
+ "releases": {
+ "methods": {
+ "update": {
+ "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"
+ },
+ "response": {
+ "$ref": "Release"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path",
+ "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ]
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/releases",
+ "path": "v1/{+name}/releases",
+ "id": "firebaserules.projects.releases.create",
+ "description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method.",
+ "request": {
+ "$ref": "Release"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Release"
+ },
+ "parameters": {
+ "name": {
+ "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ]
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "id": "firebaserules.projects.releases.delete",
+ "path": "v1/{+name}",
+ "description": "Delete a `Release` by resource name."
+ },
+ "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.",
+ "response": {
+ "$ref": "ListReleasesResponse"
+ },
+ "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": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Next page token for the next batch of `Release` instances."
+ },
+ "name": {
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load fewer\nthan `page_size` results due to the size of the output. To traverse all of\nthe releases, the caller should iterate until the `page_token` on the\nresponse is empty.",
+ "type": "integer"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.\n\nExample 1: A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2: A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters are\nrelative to the project. Fully qualified prefixed may also be used. e.g.\n`test_suite_name=projects/foo/testsuites/uuid1`"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/releases",
+ "id": "firebaserules.projects.releases.list",
+ "path": "v1/{+name}/releases"
+ },
+ "get": {
+ "description": "Get a `Release` by name.",
+ "response": {
+ "$ref": "Release"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path",
+ "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "id": "firebaserules.projects.releases.get",
+ "path": "v1/{+name}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://firebaserules.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/genomics/v1/genomics-api.json b/genomics/v1/genomics-api.json
index 7e7b05b..877ff05 100644
--- a/genomics/v1/genomics-api.json
+++ b/genomics/v1/genomics-api.json
@@ -1,12 +1,1424 @@
{
+ "batchPath": "batch",
+ "documentationLink": "https://cloud.google.com/genomics",
+ "id": "genomics:v1",
+ "revision": "20170824",
+ "title": "Genomics API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
+ "readgroupsets": {
+ "methods": {
+ "import": {
+ "flatPath": "v1/readgroupsets:import",
+ "path": "v1/readgroupsets:import",
+ "id": "genomics.readgroupsets.import",
+ "request": {
+ "$ref": "ImportReadGroupSetsRequest"
+ },
+ "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {}
+ },
+ "delete": {
+ "description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "readGroupSetId": {
+ "description": "The ID of the read group set to be deleted. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "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}"
+ },
+ "export": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "readGroupSetId": {
+ "description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set.",
+ "type": "string",
+ "required": true,
+ "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",
+ "description": "Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats.",
+ "request": {
+ "$ref": "ExportReadGroupSetRequest"
+ }
+ },
+ "search": {
+ "response": {
+ "$ref": "SearchReadGroupSetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/readgroupsets/search",
+ "id": "genomics.readgroupsets.search",
+ "path": "v1/readgroupsets/search",
+ "description": "Searches for read group sets matching the criteria.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).",
+ "request": {
+ "$ref": "SearchReadGroupSetsRequest"
+ }
+ },
+ "get": {
+ "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)",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "description": "The ID of the read group set.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
+ "type": "string",
+ "location": "query"
+ },
+ "readGroupSetId": {
+ "location": "path",
+ "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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."
+ }
+ },
+ "resources": {
+ "coveragebuckets": {
+ "methods": {
+ "list": {
+ "description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset.",
+ "response": {
+ "$ref": "ListCoverageBucketsResponse"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 2048.",
+ "type": "integer"
+ },
+ "start": {
+ "format": "int64",
+ "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified. Defaults to 0.",
+ "type": "string",
+ "location": "query"
+ },
+ "readGroupSetId": {
+ "location": "path",
+ "description": "Required. The ID of the read group set over which coverage is requested.",
+ "type": "string",
+ "required": true
+ },
+ "targetBucketWidth": {
+ "location": "query",
+ "format": "int64",
+ "description": "The desired width of each reported coverage bucket in base pairs. This\nwill be rounded down to the nearest precomputed bucket width; the value\nof which is returned as `bucketWidth` in the response. Defaults\nto infinity (each bucket spans an entire reference sequence) or the length\nof the target range, if specified. The smallest precomputed\n`bucketWidth` is currently 2048 base pairs; this is subject to\nchange.",
+ "type": "string"
+ },
+ "referenceName": {
+ "location": "query",
+ "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
+ "type": "string"
+ },
+ "end": {
+ "format": "int64",
+ "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
+ "id": "genomics.readgroupsets.coveragebuckets.list",
+ "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets"
+ }
+ }
+ }
+ }
+ },
+ "reads": {
+ "methods": {
+ "search": {
+ "request": {
+ "$ref": "SearchReadsRequest"
+ },
+ "description": "Gets a list of reads for one or more read group sets.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).",
+ "response": {
+ "$ref": "SearchReadsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/reads/search",
+ "id": "genomics.reads.search",
+ "path": "v1/reads/search"
+ }
+ }
+ },
+ "callsets": {
+ "methods": {
+ "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"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/callsets/search",
+ "path": "v1/callsets/search",
+ "id": "genomics.callsets.search"
+ },
+ "get": {
+ "description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameters": {
+ "callSetId": {
+ "location": "path",
+ "description": "The ID of the call set.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/callsets/{callSetId}",
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.get"
+ },
+ "patch": {
+ "flatPath": "v1/callsets/{callSetId}",
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.patch",
+ "description": "Updates a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
+ "request": {
+ "$ref": "CallSet"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "type": "string",
+ "location": "query"
+ },
+ "callSetId": {
+ "description": "The ID of the call set to be updated.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "create": {
+ "request": {
+ "$ref": "CallSet"
+ },
+ "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "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": {
+ "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)",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "callSetId": {
+ "location": "path",
+ "description": "The ID of the call set to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ }
+ }
+ }
+ },
+ "variants": {
+ "methods": {
+ "search": {
+ "response": {
+ "$ref": "SearchVariantsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants/search",
+ "id": "genomics.variants.search",
+ "path": "v1/variants/search",
+ "request": {
+ "$ref": "SearchVariantsRequest"
+ },
+ "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126)."
+ },
+ "patch": {
+ "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.",
+ "response": {
+ "$ref": "Variant"
+ },
+ "parameterOrder": [
+ "variantId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "variantId": {
+ "description": "The ID of the variant to be updated.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "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": {
+ "description": "The ID of the variant.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/variants/{variantId}",
+ "path": "v1/variants/{variantId}",
+ "id": "genomics.variants.get"
+ },
+ "delete": {
+ "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.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/variants/{variantId}",
+ "path": "v1/variants/{variantId}",
+ "id": "genomics.variants.delete",
+ "description": "Deletes a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "merge": {
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "import": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants:import",
+ "id": "genomics.variants.import",
+ "path": "v1/variants:import",
+ "description": "Creates variant data by asynchronously importing the provided information.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set.",
+ "request": {
+ "$ref": "ImportVariantsRequest"
+ }
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Variant"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants",
+ "path": "v1/variants",
+ "id": "genomics.variants.create",
+ "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)"
+ }
+ }
+ },
+ "annotationsets": {
+ "methods": {
+ "search": {
+ "request": {
+ "$ref": "SearchAnnotationSetsRequest"
+ },
+ "description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.",
+ "response": {
+ "$ref": "SearchAnnotationSetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "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"
+ },
+ "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.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.get"
+ },
+ "update": {
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.update",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "request": {
+ "$ref": "AnnotationSet"
+ },
+ "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.",
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified, all\nmutable fields will be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "annotationSetId": {
+ "location": "path",
+ "description": "The ID of the annotation set to be updated.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "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",
+ "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": {
+ "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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "annotationSetId": {
+ "description": "The ID of the annotation set to be deleted.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ }
+ }
+ },
+ "references": {
+ "methods": {
+ "search": {
+ "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).",
+ "request": {
+ "$ref": "SearchReferencesRequest"
+ },
+ "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"
+ ],
+ "flatPath": "v1/references/search",
+ "id": "genomics.references.search",
+ "path": "v1/references/search"
+ },
+ "get": {
+ "flatPath": "v1/references/{referenceId}",
+ "id": "genomics.references.get",
+ "path": "v1/references/{referenceId}",
+ "description": "Gets a reference.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).",
+ "response": {
+ "$ref": "Reference"
+ },
+ "parameterOrder": [
+ "referenceId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "referenceId": {
+ "description": "The ID of the reference.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ }
+ },
+ "resources": {
+ "bases": {
+ "methods": {
+ "list": {
+ "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "referenceId"
+ ],
+ "response": {
+ "$ref": "ListBasesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "end": {
+ "format": "int64",
+ "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs).",
+ "type": "integer",
+ "location": "query"
+ },
+ "start": {
+ "location": "query",
+ "format": "int64",
+ "description": "The start position (0-based) of this query. Defaults to 0.",
+ "type": "string"
+ },
+ "referenceId": {
+ "location": "path",
+ "description": "The ID of the reference.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/references/{referenceId}/bases",
+ "path": "v1/references/{referenceId}/bases",
+ "id": "genomics.references.bases.list"
+ }
+ }
+ }
+ }
+ },
+ "datasets": {
+ "methods": {
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^datasets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
+ "id": "genomics.datasets.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nSee \u003ca href=\"/iam/docs/managing-policies#testing_permissions\"\u003eTesting\nPermissions\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ },
+ "delete": {
+ "description": "Deletes a dataset and all of its contents (all read group sets,\nreference sets, variant sets, call sets, annotation sets, etc.)\nThis is reversible (up to one week after the deletion) via\nthe\ndatasets.undelete\noperation.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "DELETE",
+ "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.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.delete",
+ "path": "v1/datasets/{datasetId}"
+ },
+ "list": {
+ "description": "Lists datasets within a project.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "ListDatasetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
+ "type": "integer",
+ "location": "query"
+ },
+ "projectId": {
+ "description": "Required. The Google Cloud project ID to list datasets for.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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"
+ },
+ "create": {
+ "description": "Creates a new dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets",
+ "path": "v1/datasets",
+ "id": "genomics.datasets.create"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^datasets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "genomics.datasets.setIamPolicy"
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^datasets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
+ "id": "genomics.datasets.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "response": {
+ "$ref": "Dataset"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "type": "string",
+ "location": "query"
+ },
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be updated.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}",
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.patch",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "response": {
+ "$ref": "Dataset"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "The ID of the dataset.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}",
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.get",
+ "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "undelete": {
+ "request": {
+ "$ref": "UndeleteDatasetRequest"
+ },
+ "description": "Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "response": {
+ "$ref": "Dataset"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be undeleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}:undelete",
+ "path": "v1/datasets/{datasetId}:undelete",
+ "id": "genomics.datasets.undelete"
+ }
+ }
+ },
+ "annotations": {
+ "methods": {
+ "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"
+ },
+ "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"
+ ],
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameters": {
+ "annotationId": {
+ "location": "path",
+ "description": "The ID of the annotation to be retrieved.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/annotations/{annotationId}",
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.get"
+ },
+ "update": {
+ "request": {
+ "$ref": "Annotation"
+ },
+ "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "annotationId": {
+ "description": "The ID of the annotation to be updated.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.update",
+ "path": "v1/annotations/{annotationId}"
+ },
+ "delete": {
+ "flatPath": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.delete",
+ "path": "v1/annotations/{annotationId}",
+ "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "annotationId": {
+ "description": "The ID of the annotation to be deleted.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "create": {
+ "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.",
+ "request": {
+ "$ref": "Annotation"
+ },
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "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"
+ },
+ "batchCreate": {
+ "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",
+ "id": "genomics.annotations.batchCreate",
+ "path": "v1/annotations:batchCreate",
+ "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.",
+ "request": {
+ "$ref": "BatchCreateAnnotationsRequest"
+ }
+ }
+ }
+ },
+ "variantsets": {
+ "methods": {
+ "export": {
+ "description": "Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "ExportVariantSetRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "variantSetId": {
+ "description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}:export",
+ "id": "genomics.variantsets.export",
+ "path": "v1/variantsets/{variantSetId}:export"
+ },
+ "search": {
+ "response": {
+ "$ref": "SearchVariantSetsResponse"
+ },
+ "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/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)."
+ },
+ "get": {
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "variantSetId": {
+ "description": "Required. The ID of the variant set.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "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)"
+ },
+ "patch": {
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.patch",
+ "description": "Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "VariantSet"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
+ "type": "string",
+ "location": "query"
+ },
+ "variantSetId": {
+ "description": "The ID of the variant to be updated (must already exist).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "variantSetId": {
+ "location": "path",
+ "description": "The ID of the variant set to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.delete",
+ "path": "v1/variantsets/{variantSetId}",
+ "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "create": {
+ "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",
+ "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"
+ }
+ }
+ },
"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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "genomics.operations.get",
+ "path": "v1/{+name}"
+ },
+ "list": {
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations$"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/operations",
+ "id": "genomics.operations.list",
+ "path": "v1/{+name}",
+ "description": "Lists operations that match the specified filter in the request."
+ },
"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"
},
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
"response": {
"$ref": "Empty"
},
@@ -14,90 +1426,22 @@
"name"
],
"httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
"flatPath": "v1/operations/{operationsId}:cancel",
"id": "genomics.operations.cancel",
"path": "v1/{+name}:cancel"
- },
- "get": {
- "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.",
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/operations/{operationsId}"
- },
- "list": {
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "genomics.operations.list",
- "description": "Lists operations that match the specified filter in the request.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true
- }
- }
}
}
},
@@ -124,1367 +1468,30 @@
"path": "v1/referencesets/search"
},
"get": {
+ "flatPath": "v1/referencesets/{referenceSetId}",
+ "id": "genomics.referencesets.get",
+ "path": "v1/referencesets/{referenceSetId}",
"description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).",
- "parameterOrder": [
- "referenceSetId"
- ],
"response": {
"$ref": "ReferenceSet"
},
+ "parameterOrder": [
+ "referenceSetId"
+ ],
"httpMethod": "GET",
"parameters": {
"referenceSetId": {
- "location": "path",
"description": "The ID of the reference set.",
"type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/referencesets/{referenceSetId}",
- "id": "genomics.referencesets.get",
- "path": "v1/referencesets/{referenceSetId}"
- }
- }
- },
- "callsets": {
- "methods": {
- "delete": {
- "description": "Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "callSetId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "callSetId": {
- "description": "The ID of the call set to be deleted.",
- "type": "string",
"required": true,
"location": "path"
}
},
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.delete"
- },
- "search": {
- "flatPath": "v1/callsets/search",
- "id": "genomics.callsets.search",
- "path": "v1/callsets/search",
- "description": "Gets a list of call sets matching the criteria.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).",
- "request": {
- "$ref": "SearchCallSetsRequest"
- },
- "response": {
- "$ref": "SearchCallSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "callSetId"
- ],
- "response": {
- "$ref": "CallSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "callSetId": {
- "description": "The ID of the call set.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "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)"
- },
- "patch": {
- "parameters": {
- "updateMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated."
- },
- "callSetId": {
- "location": "path",
- "description": "The ID of the call set to be updated.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.patch",
- "path": "v1/callsets/{callSetId}",
- "description": "Updates a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "CallSet"
- },
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "PATCH"
- },
- "create": {
- "path": "v1/callsets",
- "id": "genomics.callsets.create",
- "request": {
- "$ref": "CallSet"
- },
- "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "CallSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/callsets"
- }
- }
- },
- "reads": {
- "methods": {
- "search": {
- "request": {
- "$ref": "SearchReadsRequest"
- },
- "description": "Gets a list of reads for one or more read group sets.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchReadsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/reads/search",
- "path": "v1/reads/search",
- "id": "genomics.reads.search"
- }
- }
- },
- "readgroupsets": {
- "methods": {
- "export": {
- "httpMethod": "POST",
- "parameterOrder": [
- "readGroupSetId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "readGroupSetId": {
- "location": "path",
- "description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/readgroupsets/{readGroupSetId}:export",
- "path": "v1/readgroupsets/{readGroupSetId}:export",
- "id": "genomics.readgroupsets.export",
- "request": {
- "$ref": "ExportReadGroupSetRequest"
- },
- "description": "Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats."
- },
- "search": {
- "response": {
- "$ref": "SearchReadGroupSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/readgroupsets/search",
- "id": "genomics.readgroupsets.search",
- "path": "v1/readgroupsets/search",
- "request": {
- "$ref": "SearchReadGroupSetsRequest"
- },
- "description": "Searches for read group sets matching the criteria.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135)."
- },
- "patch": {
- "description": "Updates a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "ReadGroupSet"
- },
- "response": {
- "$ref": "ReadGroupSet"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "readGroupSetId": {
- "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.patch",
- "path": "v1/readgroupsets/{readGroupSetId}"
- },
- "get": {
- "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)",
- "httpMethod": "GET",
- "parameterOrder": [
- "readGroupSetId"
- ],
- "response": {
- "$ref": "ReadGroupSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "readGroupSetId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the read group set."
- }
- }
- },
- "delete": {
- "description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "readGroupSetId": {
- "type": "string",
- "required": true,
- "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."
- }
- },
- "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}"
- },
- "import": {
- "request": {
- "$ref": "ImportReadGroupSetsRequest"
- },
- "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/readgroupsets:import",
- "id": "genomics.readgroupsets.import",
- "path": "v1/readgroupsets:import"
- }
- },
- "resources": {
- "coveragebuckets": {
- "methods": {
- "list": {
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "ListCoverageBucketsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 2048.",
- "type": "integer"
- },
- "start": {
- "location": "query",
- "format": "int64",
- "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified. Defaults to 0.",
- "type": "string"
- },
- "readGroupSetId": {
- "description": "Required. The ID of the read group set over which coverage is requested.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "targetBucketWidth": {
- "format": "int64",
- "description": "The desired width of each reported coverage bucket in base pairs. This\nwill be rounded down to the nearest precomputed bucket width; the value\nof which is returned as `bucketWidth` in the response. Defaults\nto infinity (each bucket spans an entire reference sequence) or the length\nof the target range, if specified. The smallest precomputed\n`bucketWidth` is currently 2048 base pairs; this is subject to\nchange.",
- "type": "string",
- "location": "query"
- },
- "referenceName": {
- "location": "query",
- "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
- "type": "string"
- },
- "end": {
- "format": "int64",
- "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
- "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."
- }
- }
- }
- }
- },
- "variants": {
- "methods": {
- "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)",
- "response": {
- "$ref": "Variant"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "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": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/variants/search",
- "id": "genomics.variants.search",
- "path": "v1/variants/search",
- "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"
- },
- "get": {
- "response": {
- "$ref": "Variant"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "variantId"
- ],
- "parameters": {
- "variantId": {
- "location": "path",
- "description": "The ID of the variant.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/variants/{variantId}",
- "id": "genomics.variants.get",
- "path": "v1/variants/{variantId}",
- "description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "patch": {
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.patch",
- "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.",
- "request": {
- "$ref": "Variant"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "variantId"
- ],
- "response": {
- "$ref": "Variant"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.",
- "type": "string"
- },
- "variantId": {
- "location": "path",
- "description": "The ID of the variant to be updated.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants/{variantId}"
- },
- "import": {
- "request": {
- "$ref": "ImportVariantsRequest"
- },
- "description": "Creates variant data by asynchronously importing the provided information.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set.",
- "response": {
- "$ref": "Operation"
- },
- "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",
- "id": "genomics.variants.import",
- "path": "v1/variants:import"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "variantId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "variantId": {
- "description": "The ID of the variant to be deleted.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants/{variantId}",
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.delete",
- "description": "Deletes a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "merge": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants:merge",
- "id": "genomics.variants.merge",
- "path": "v1/variants:merge",
- "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"
- }
- }
- }
- },
- "annotationsets": {
- "methods": {
- "delete": {
- "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "annotationSetId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "annotationSetId": {
- "description": "The ID of the annotation set to be deleted.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "path": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.delete"
- },
- "search": {
- "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"
- },
- "response": {
- "$ref": "SearchAnnotationSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "annotationSetId"
- ],
- "response": {
- "$ref": "AnnotationSet"
- },
- "parameters": {
- "annotationSetId": {
- "location": "path",
- "description": "The ID of the annotation set to be retrieved.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "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."
- },
- "update": {
- "request": {
- "$ref": "AnnotationSet"
- },
- "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "annotationSetId"
- ],
- "response": {
- "$ref": "AnnotationSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "annotationSetId": {
- "description": "The ID of the annotation set to be updated.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified, all\nmutable fields will be updated.",
- "type": "string"
- }
- },
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "path": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.update"
- },
- "create": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotationsets",
- "id": "genomics.annotationsets.create",
- "path": "v1/annotationsets",
- "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).",
- "request": {
- "$ref": "AnnotationSet"
- },
- "response": {
- "$ref": "AnnotationSet"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- }
- }
- },
- "references": {
- "methods": {
- "search": {
- "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).",
- "request": {
- "$ref": "SearchReferencesRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchReferencesResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/references/search",
- "path": "v1/references/search",
- "id": "genomics.references.search"
- },
- "get": {
- "response": {
- "$ref": "Reference"
- },
- "parameterOrder": [
- "referenceId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "referenceId": {
- "location": "path",
- "description": "The ID of the reference.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/references/{referenceId}",
- "id": "genomics.references.get",
- "path": "v1/references/{referenceId}",
- "description": "Gets a reference.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158)."
- }
- },
- "resources": {
- "bases": {
- "methods": {
- "list": {
- "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).",
- "parameterOrder": [
- "referenceId"
- ],
- "response": {
- "$ref": "ListBasesResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "referenceId": {
- "description": "The ID of the reference.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "end": {
- "location": "query",
- "format": "int64",
- "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
- "type": "string"
- },
- "pageToken": {
- "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",
- "format": "int32",
- "description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs)."
- },
- "start": {
- "format": "int64",
- "description": "The start position (0-based) of this query. Defaults to 0.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/references/{referenceId}/bases",
- "id": "genomics.references.bases.list",
- "path": "v1/references/{referenceId}/bases"
- }
- }
- }
- }
- },
- "datasets": {
- "methods": {
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^datasets/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
- "id": "genomics.datasets.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nSee \u003ca href=\"/iam/docs/managing-policies#testing_permissions\"\u003eTesting\nPermissions\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "delete": {
- "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)",
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "datasetId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the dataset to be deleted."
- }
- }
- },
- "list": {
- "response": {
- "$ref": "ListDatasetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
- "type": "integer"
- },
- "projectId": {
- "description": "Required. The Google Cloud project ID to list datasets for.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "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": {
- "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
- "id": "genomics.datasets.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^datasets/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Dataset"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets",
- "path": "v1/datasets",
- "id": "genomics.datasets.create",
- "description": "Creates a new dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "request": {
- "$ref": "Dataset"
- }
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^datasets/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
- "id": "genomics.datasets.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "request": {
- "$ref": "GetIamPolicyRequest"
- }
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "parameters": {
- "datasetId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the dataset to be undeleted."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetId}:undelete",
- "path": "v1/datasets/{datasetId}:undelete",
- "id": "genomics.datasets.undelete"
- },
- "get": {
- "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "datasetId": {
- "description": "The ID of the dataset.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.get",
- "path": "v1/datasets/{datasetId}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "parameters": {
- "datasetId": {
- "location": "path",
- "description": "The ID of the dataset to be updated.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetId}",
- "path": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.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"
- }
- }
- }
- },
- "variantsets": {
- "methods": {
- "create": {
- "flatPath": "v1/variantsets",
- "path": "v1/variantsets",
- "id": "genomics.variantsets.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"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "export": {
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "variantSetId": {
- "location": "path",
- "description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}:export",
- "id": "genomics.variantsets.export",
- "path": "v1/variantsets/{variantSetId}:export",
- "request": {
- "$ref": "ExportVariantSetRequest"
- },
- "description": "Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "POST"
- },
- "search": {
- "response": {
- "$ref": "SearchVariantSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/variantsets/search",
- "id": "genomics.variantsets.search",
- "path": "v1/variantsets/search",
- "description": "Returns a list of all variant sets matching search criteria.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).",
- "request": {
- "$ref": "SearchVariantSetsRequest"
- }
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "variantSetId"
- ],
- "response": {
- "$ref": "VariantSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
- "type": "string"
- },
- "variantSetId": {
- "location": "path",
- "description": "The ID of the variant to be updated (must already exist).",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}",
- "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)"
- },
- "get": {
- "flatPath": "v1/variantsets/{variantSetId}",
- "path": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.get",
- "description": "Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "GET",
- "response": {
- "$ref": "VariantSet"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "parameters": {
- "variantSetId": {
- "location": "path",
- "description": "Required. The ID of the variant set.",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
]
- },
- "delete": {
- "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "variantSetId": {
- "location": "path",
- "description": "The ID of the variant set to be deleted.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.delete",
- "path": "v1/variantsets/{variantSetId}"
- }
- }
- },
- "annotations": {
- "methods": {
- "delete": {
- "id": "genomics.annotations.delete",
- "path": "v1/annotations/{annotationId}",
- "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "annotationId": {
- "location": "path",
- "description": "The ID of the annotation to be deleted.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/annotations/{annotationId}"
- },
- "create": {
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations",
- "id": "genomics.annotations.create",
- "path": "v1/annotations",
- "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.",
- "request": {
- "$ref": "Annotation"
- }
- },
- "batchCreate": {
- "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",
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "BatchCreateAnnotationsResponse"
- }
- },
- "search": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchAnnotationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/annotations/search",
- "path": "v1/annotations/search",
- "id": "genomics.annotations.search",
- "request": {
- "$ref": "SearchAnnotationsRequest"
- },
- "description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets."
- },
- "get": {
- "parameterOrder": [
- "annotationId"
- ],
- "response": {
- "$ref": "Annotation"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "annotationId": {
- "description": "The ID of the annotation to be retrieved.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.get",
- "path": "v1/annotations/{annotationId}",
- "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set."
- },
- "update": {
- "request": {
- "$ref": "Annotation"
- },
- "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated."
- },
- "annotationId": {
- "description": "The ID of the annotation to be updated.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.update",
- "path": "v1/annotations/{annotationId}"
}
}
}
@@ -1502,32 +1509,32 @@
"location": "query"
},
"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": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
"alt": {
"enumDescriptions": [
@@ -1546,9 +1553,9 @@
"type": "string"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"access_token": {
"location": "query",
@@ -1556,9 +1563,9 @@
"type": "string"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
"description": "Pretty-print response.",
@@ -1567,17 +1574,806 @@
"location": "query"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"schemas": {
+ "SearchVariantsRequest": {
+ "description": "The variant search request.",
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "end": {
+ "format": "int64",
+ "description": "The end of the window, 0-based exclusive. If unspecified or 0, defaults to\nthe length of the reference.",
+ "type": "string"
+ },
+ "maxCalls": {
+ "format": "int32",
+ "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.",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of variants to return in a single page. If unspecified,\ndefaults to 5000. The maximum value is 10000.",
+ "type": "integer"
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "variantName": {
+ "description": "Only return variants which have exactly this name.",
+ "type": "string"
+ },
+ "start": {
+ "format": "int64",
+ "description": "The beginning of the window (0-based, inclusive) for which\noverlapping variants should be returned. If unspecified, defaults to 0.",
+ "type": "string"
+ },
+ "referenceName": {
+ "description": "Required. Only return variants in this reference sequence.",
+ "type": "string"
+ }
+ },
+ "id": "SearchVariantsRequest"
+ },
+ "OperationMetadata": {
+ "description": "Metadata describing an Operation.",
+ "type": "object",
+ "properties": {
+ "request": {
+ "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "runtimeMetadata": {
+ "description": "Runtime metadata on this Operation.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
+ "type": "object"
+ },
+ "projectId": {
+ "description": "The Google Cloud Project in which the job is scoped.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The time at which the job stopped running.",
+ "type": "string"
+ },
+ "events": {
+ "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
+ "items": {
+ "$ref": "OperationEvent"
+ },
+ "type": "array"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The time at which the job began to run.",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadata"
+ },
+ "SearchReadGroupSetsRequest": {
+ "description": "The read group set search request.",
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Only return read group sets for which a substring of the name matches this\nstring.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 1024.",
+ "type": "integer"
+ },
+ "datasetIds": {
+ "description": "Restricts this query to read group sets within the given datasets. At least\none ID must be provided.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SearchReadGroupSetsRequest"
+ },
+ "SearchAnnotationsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
+ "annotations": {
+ "description": "The matching annotations.",
+ "items": {
+ "$ref": "Annotation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SearchAnnotationsResponse"
+ },
+ "ClinicalCondition": {
+ "type": "object",
+ "properties": {
+ "conceptId": {
+ "description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/",
+ "type": "string"
+ },
+ "names": {
+ "description": "A set of names for the condition.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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.",
+ "items": {
+ "$ref": "ExternalId"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ClinicalCondition"
+ },
+ "SearchReadsResponse": {
+ "description": "The read search response.",
+ "type": "object",
+ "properties": {
+ "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.",
+ "items": {
+ "$ref": "Read"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ }
+ },
+ "id": "SearchReadsResponse"
+ },
+ "Program": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The display name of the program. This is typically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'.",
+ "type": "string"
+ },
+ "prevProgramId": {
+ "description": "The ID of the program run before this one.",
+ "type": "string"
+ },
+ "commandLine": {
+ "description": "The command line used to run this program.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the program run.",
+ "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"
+ }
+ },
+ "id": "Program"
+ },
+ "ComputeEngine": {
+ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
+ "type": "object",
+ "properties": {
+ "diskNames": {
+ "description": "The names of the disks that were created for this pipeline.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "machineType": {
+ "description": "The machine type of the instance.",
+ "type": "string"
+ },
+ "instanceName": {
+ "description": "The instance on which the operation is running.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The availability zone in which the instance resides.",
+ "type": "string"
+ }
+ },
+ "id": "ComputeEngine"
+ },
+ "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": {
+ "format": "float",
+ "description": "The average number of reads which are aligned to each individual\nreference base in this bucket.",
+ "type": "number"
+ }
+ },
+ "id": "CoverageBucket"
+ },
+ "ExternalId": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The id used by the source of this data.",
+ "type": "string"
+ },
+ "sourceName": {
+ "description": "The name of the source of this data.",
+ "type": "string"
+ }
+ },
+ "id": "ExternalId"
+ },
+ "SearchVariantSetsRequest": {
+ "description": "The search variant sets request.",
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
+ "type": "integer"
+ },
+ "datasetIds": {
+ "description": "Exactly one dataset ID must be provided here. Only variant sets which\nbelong to this dataset will be returned.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SearchVariantSetsRequest"
+ },
+ "VariantSetMetadata": {
+ "description": "Metadata describes a single piece of variant call metadata.\nThese data include a top level key and either a single value string (value)\nor a list of key-value pairs (info.)\nValue and info are mutually exclusive.",
+ "type": "object",
+ "properties": {
+ "info": {
+ "description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ }
+ },
+ "type": {
+ "description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "FLAG",
+ "CHARACTER",
+ "STRING"
+ ]
+ },
+ "value": {
+ "description": "The value field for simple metadata",
+ "type": "string"
+ },
+ "id": {
+ "description": "User-provided ID field, not enforced by this API.\nTwo or more pieces of structured metadata with identical\nid and key fields are considered equivalent.",
+ "type": "string"
+ },
+ "number": {
+ "description": "The number of values that can be included in a field described by this\nmetadata.",
+ "type": "string"
+ },
+ "key": {
+ "description": "The top-level key.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A textual description of this metadata.",
+ "type": "string"
+ }
+ },
+ "id": "VariantSetMetadata"
+ },
+ "Reference": {
+ "description": "A reference is a canonical assembled DNA sequence, intended to act as a\nreference coordinate space for other genomic annotations. A single reference\nmight represent the human chromosome 1 or mitochandrial DNA, for instance. A\nreference belongs to one or more reference sets.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of this reference, for example `22`.",
+ "type": "string"
+ },
+ "md5checksum": {
+ "description": "MD5 of the upper-case sequence excluding all whitespace characters (this\nis equivalent to SQ:M5 in SAM). This value is represented in lower case\nhexadecimal format.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated reference ID, unique across all references.",
+ "type": "string"
+ },
+ "length": {
+ "format": "int64",
+ "description": "The length of this reference's sequence.",
+ "type": "string"
+ },
+ "sourceAccessions": {
+ "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405.26`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "ncbiTaxonId": {
+ "format": "int32",
+ "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.",
+ "type": "integer"
+ },
+ "sourceUri": {
+ "description": "The URI from which the sequence was obtained. Typically specifies a FASTA\nformat file.",
+ "type": "string"
+ }
+ },
+ "id": "Reference"
+ },
+ "SearchReferenceSetsRequest": {
+ "type": "object",
+ "properties": {
+ "md5checksums": {
+ "description": "If present, return reference sets for which the\nmd5checksum matches exactly.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "accessions": {
+ "description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
+ "type": "integer"
+ },
+ "assemblyId": {
+ "description": "If present, return reference sets for which a substring of their\n`assemblyId` matches this string (case insensitive).",
+ "type": "string"
+ }
+ },
+ "id": "SearchReferenceSetsRequest"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "MergeVariantsRequest": {
+ "type": "object",
+ "properties": {
+ "infoMergeConfig": {
+ "additionalProperties": {
+ "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.",
+ "type": "object"
+ },
+ "variantSetId": {
+ "description": "The destination variant set.",
+ "type": "string"
+ },
+ "variants": {
+ "description": "The variants to be merged with existing variants.",
+ "items": {
+ "$ref": "Variant"
+ },
+ "type": "array"
+ }
+ },
+ "id": "MergeVariantsRequest"
+ },
+ "BatchCreateAnnotationsRequest": {
+ "type": "object",
+ "properties": {
+ "annotations": {
+ "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
+ "items": {
+ "$ref": "Annotation"
+ },
+ "type": "array"
+ },
+ "requestId": {
+ "description": "A unique request ID which enables the server to detect duplicated requests.\nIf provided, duplicated requests will result in the same response; if not\nprovided, duplicated requests may result in duplicated data. For a given\nannotation set, callers should not reuse `request_id`s when writing\ndifferent batches of annotations - behavior in this case is undefined.\nA common approach is to use a UUID. For batch jobs where worker crashes are\na possibility, consider using some unique variant of a worker or run ID.",
+ "type": "string"
+ }
+ },
+ "id": "BatchCreateAnnotationsRequest"
+ },
+ "Read": {
+ "description": "A read alignment describes a linear alignment of a string of DNA to a\nreference sequence, in addition to metadata\nabout the fragment (the molecule of DNA sequenced) and the read (the bases\nwhich were read by the sequencer). A read is equivalent to a line in a SAM\nfile. A read belongs to exactly one read group and exactly one\nread group set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\n### Reverse-stranded reads\n\nMapped reads (reads having a non-null `alignment`) can be aligned to either\nthe forward or the reverse strand of their associated reference. Strandedness\nof a mapped read is encoded by `alignment.position.reverseStrand`.\n\nIf we consider the reference to be a forward-stranded coordinate space of\n`[0, reference.length)` with `0` as the left-most position and\n`reference.length` as the right-most position, reads are always aligned left\nto right. That is, `alignment.position.position` always refers to the\nleft-most reference coordinate and `alignment.cigar` describes the alignment\nof this read to the reference from left to right. All per-base fields such as\n`alignedSequence` and `alignedQuality` share this same left-to-right\norientation; this is true of reads which are aligned to either strand. For\nreverse-stranded reads, this means that `alignedSequence` is the reverse\ncomplement of the bases that were originally reported by the sequencing\nmachine.\n\n### Generating a reference-aligned sequence string\n\nWhen interacting with mapped reads, it's often useful to produce a string\nrepresenting the local alignment of the read to reference. The following\npseudocode demonstrates one way of doing this:\n\n out = \"\"\n offset = 0\n for c in read.alignment.cigar {\n switch c.operation {\n case \"ALIGNMENT_MATCH\", \"SEQUENCE_MATCH\", \"SEQUENCE_MISMATCH\":\n out += read.alignedSequence[offset:offset+c.operationLength]\n offset += c.operationLength\n break\n case \"CLIP_SOFT\", \"INSERT\":\n offset += c.operationLength\n break\n case \"PAD\":\n out += repeat(\"*\", c.operationLength)\n break\n case \"DELETE\":\n out += repeat(\"-\", c.operationLength)\n break\n case \"SKIP\":\n out += repeat(\" \", c.operationLength)\n break\n case \"CLIP_HARD\":\n break\n }\n }\n return out\n\n### Converting to SAM's CIGAR string\n\nThe following pseudocode generates a SAM CIGAR string from the\n`cigar` field. Note that this is a lossy conversion\n(`cigar.referenceSequence` is lost).\n\n cigarMap = {\n \"ALIGNMENT_MATCH\": \"M\",\n \"INSERT\": \"I\",\n \"DELETE\": \"D\",\n \"SKIP\": \"N\",\n \"CLIP_SOFT\": \"S\",\n \"CLIP_HARD\": \"H\",\n \"PAD\": \"P\",\n \"SEQUENCE_MATCH\": \"=\",\n \"SEQUENCE_MISMATCH\": \"X\",\n }\n cigarStr = \"\"\n for c in read.alignment.cigar {\n cigarStr += c.operationLength + cigarMap[c.operation]\n }\n return cigarStr",
+ "type": "object",
+ "properties": {
+ "secondaryAlignment": {
+ "description": "Whether this alignment is secondary. Equivalent to SAM flag 0x100.\nA secondary alignment represents an alternative to the primary alignment\nfor this read. Aligners may return secondary alignments if a read can map\nambiguously to multiple coordinates in the genome. By convention, each read\nhas one and only one alignment where both `secondaryAlignment`\nand `supplementaryAlignment` are false.",
+ "type": "boolean"
+ },
+ "fragmentName": {
+ "description": "The fragment name. Equivalent to QNAME (query template name) in SAM.",
+ "type": "string"
+ },
+ "readGroupSetId": {
+ "description": "The ID of the read group set this read belongs to. A read belongs to\nexactly one read group set.",
+ "type": "string"
+ },
+ "duplicateFragment": {
+ "description": "The fragment is a PCR or optical duplicate (SAM flag 0x400).",
+ "type": "boolean"
+ },
+ "readNumber": {
+ "format": "int32",
+ "description": "The read number in sequencing. 0-based and less than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.",
+ "type": "integer"
+ },
+ "alignedSequence": {
+ "description": "The bases of the read sequence contained in this alignment record,\n**without CIGAR operations applied** (equivalent to SEQ in SAM).\n`alignedSequence` and `alignedQuality` may be\nshorter than the full read sequence and quality. This will occur if the\nalignment is part of a chimeric alignment, or if the read was trimmed. When\nthis occurs, the CIGAR for this read will begin/end with a hard clip\noperator that will indicate the length of the excised sequence.",
+ "type": "string"
+ },
+ "readGroupId": {
+ "description": "The ID of the read group this read belongs to. A read belongs to exactly\none read group. This is a server-generated ID which is distinct from SAM's\nRG tag (for that value, see\nReadGroup.name).",
+ "type": "string"
+ },
+ "info": {
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ }
+ },
+ "nextMatePosition": {
+ "$ref": "Position",
+ "description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM."
+ },
+ "properPlacement": {
+ "description": "The orientation and the distance between reads from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2).",
+ "type": "boolean"
+ },
+ "supplementaryAlignment": {
+ "description": "Whether this alignment is supplementary. Equivalent to SAM flag 0x800.\nSupplementary alignments are used in the representation of a chimeric\nalignment. In a chimeric alignment, a read is split into multiple\nlinear alignments that map to different reference contigs. The first\nlinear alignment in the read will be designated as the representative\nalignment; the remaining linear alignments will be designated as\nsupplementary alignments. These alignments may have different mapping\nquality scores. In each linear alignment in a chimeric alignment, the read\nwill be hard clipped. The `alignedSequence` and\n`alignedQuality` fields in the alignment record will only\nrepresent the bases for its respective linear alignment.",
+ "type": "boolean"
+ },
+ "fragmentLength": {
+ "format": "int32",
+ "description": "The observed length of the fragment, equivalent to TLEN in SAM.",
+ "type": "integer"
+ },
+ "failedVendorQualityChecks": {
+ "description": "Whether this read did not pass filters, such as platform or vendor quality\ncontrols (SAM flag 0x200).",
+ "type": "boolean"
+ },
+ "alignedQuality": {
+ "description": "The quality of the read sequence contained in this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `alignedQuality` may be shorter than the full read\nsequence and quality. This will occur if the alignment is part of a\nchimeric alignment, or if the read was trimmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip operator that will indicate\nthe length of the excised sequence.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "alignment": {
+ "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads.",
+ "$ref": "LinearAlignment"
+ },
+ "numberReads": {
+ "format": "int32",
+ "description": "The number of reads in the fragment (extension to SAM flag 0x1).",
+ "type": "integer"
+ },
+ "id": {
+ "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
+ "type": "string"
+ }
+ },
+ "id": "Read"
+ },
+ "ReferenceSet": {
+ "description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "sourceAccessions": {
+ "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "Free text description of this reference set.",
+ "type": "string"
+ },
+ "sourceUri": {
+ "description": "The URI from which the references were obtained.",
+ "type": "string"
+ },
+ "ncbiTaxonId": {
+ "format": "int32",
+ "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
+ "type": "integer"
+ },
+ "referenceIds": {
+ "description": "The IDs of the reference objects that are part of this set.\n`Reference.md5checksum` must be unique within this set.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "assemblyId": {
+ "description": "Public id of this reference set, such as `GRCh37`.",
+ "type": "string"
+ },
+ "md5checksum": {
+ "description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated reference set ID, unique across all reference sets.",
+ "type": "string"
+ }
+ },
+ "id": "ReferenceSet"
+ },
+ "CigarUnit": {
+ "description": "A single CIGAR operation.",
+ "type": "object",
+ "properties": {
+ "operationLength": {
+ "format": "int64",
+ "description": "The number of genomic bases that the operation runs for. Required.",
+ "type": "string"
+ },
+ "operation": {
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "An alignment match indicates that a sequence can be aligned to the\nreference without evidence of an INDEL. Unlike the\n`SEQUENCE_MATCH` and `SEQUENCE_MISMATCH` operators,\nthe `ALIGNMENT_MATCH` operator does not indicate whether the\nreference and read sequences are an exact match. This operator is\nequivalent to SAM's `M`.",
+ "The insert operator indicates that the read contains evidence of bases\nbeing inserted into the reference. This operator is equivalent to SAM's\n`I`.",
+ "The delete operator indicates that the read contains evidence of bases\nbeing deleted from the reference. This operator is equivalent to SAM's\n`D`.",
+ "The skip operator indicates that this read skips a long segment of the\nreference, but the bases have not been deleted. This operator is commonly\nused when working with RNA-seq data, where reads may skip long segments\nof the reference between exons. This operator is equivalent to SAM's\n`N`.",
+ "The soft clip operator indicates that bases at the start/end of a read\nhave not been considered during alignment. This may occur if the majority\nof a read maps, except for low quality bases at the start/end of a read.\nThis operator is equivalent to SAM's `S`. Bases that are soft\nclipped will still be stored in the read.",
+ "The hard clip operator indicates that bases at the start/end of a read\nhave been omitted from this alignment. This may occur if this linear\nalignment is part of a chimeric alignment, or if the read has been\ntrimmed (for example, during error correction or to trim poly-A tails for\nRNA-seq). This operator is equivalent to SAM's `H`.",
+ "The pad operator indicates that there is padding in an alignment. This\noperator is equivalent to SAM's `P`.",
+ "This operator indicates that this portion of the aligned sequence exactly\nmatches the reference. This operator is equivalent to SAM's `=`.",
+ "This operator indicates that this portion of the aligned sequence is an\nalignment match to the reference, but a sequence mismatch. This can\nindicate a SNP or a read error. This operator is equivalent to SAM's\n`X`."
+ ],
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "ALIGNMENT_MATCH",
+ "INSERT",
+ "DELETE",
+ "SKIP",
+ "CLIP_SOFT",
+ "CLIP_HARD",
+ "PAD",
+ "SEQUENCE_MATCH",
+ "SEQUENCE_MISMATCH"
+ ]
+ },
+ "referenceSequence": {
+ "description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.",
+ "type": "string"
+ }
+ },
+ "id": "CigarUnit"
+ },
+ "AnnotationSet": {
+ "description": "An annotation set is a logical grouping of annotations that share consistent\ntype information and provenance. Examples of annotation sets include 'all\ngenes from refseq', and 'all variant annotations from ClinVar'.",
+ "type": "object",
+ "properties": {
+ "datasetId": {
+ "description": "The dataset to which this annotation set belongs.",
+ "type": "string"
+ },
+ "sourceUri": {
+ "description": "The source URI describing the file from which this annotation set was\ngenerated, if any.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The display name for this annotation set.",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "The ID of the reference set that defines the coordinate space for this\nset's annotations.",
+ "type": "string"
+ },
+ "info": {
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ }
+ },
+ "type": {
+ "enumDescriptions": [
+ "",
+ "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
+ "A `VARIANT` annotation type.",
+ "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
+ "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
+ ],
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ],
+ "description": "The type of annotations contained within this set.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated annotation set ID, unique across all annotation sets.",
+ "type": "string"
+ }
+ },
+ "id": "AnnotationSet"
+ },
+ "Transcript": {
+ "description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
+ "type": "object",
+ "properties": {
+ "geneId": {
+ "description": "The annotation ID of the gene from which this transcript is transcribed.",
+ "type": "string"
+ },
+ "exons": {
+ "description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
+ "items": {
+ "$ref": "Exon"
+ },
+ "type": "array"
+ },
+ "codingSequence": {
+ "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA.",
+ "$ref": "CodingSequence"
+ }
+ },
+ "id": "Transcript"
+ },
+ "Experiment": {
+ "type": "object",
+ "properties": {
+ "platformUnit": {
+ "description": "The platform unit used as part of this experiment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the\n@RG PU field in the SAM spec.",
+ "type": "string"
+ },
+ "instrumentModel": {
+ "description": "The instrument model used as part of this experiment. This maps to\nsequencing technology in the SAM spec.",
+ "type": "string"
+ },
+ "libraryId": {
+ "description": "A client-supplied library identifier; a library is a collection of DNA\nfragments which have been prepared for sequencing from a sample. This\nfield is important for quality control as error or bias can be introduced\nduring sample preparation.",
+ "type": "string"
+ },
+ "sequencingCenter": {
+ "description": "The sequencing center used as part of this experiment.",
+ "type": "string"
+ }
+ },
+ "id": "Experiment"
+ },
+ "ListDatasetsResponse": {
+ "description": "The dataset list response.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
+ "datasets": {
+ "description": "The list of matching Datasets.",
+ "items": {
+ "$ref": "Dataset"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListDatasetsResponse"
+ },
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
@@ -1593,6 +2389,7 @@
"id": "TestIamPermissionsRequest"
},
"Exon": {
+ "type": "object",
"properties": {
"frame": {
"format": "int32",
@@ -1605,16 +2402,21 @@
"type": "string"
},
"start": {
- "type": "string",
"format": "int64",
- "description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start."
+ "description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start.",
+ "type": "string"
}
},
- "id": "Exon",
- "type": "object"
+ "id": "Exon"
},
"ExportReadGroupSetRequest": {
+ "description": "The read group set export request.",
+ "type": "object",
"properties": {
+ "projectId": {
+ "description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
+ "type": "string"
+ },
"referenceNames": {
"description": "The reference names to export. If this is not specified, all reference\nsequences, including unmapped reads, are exported.\nUse `*` to export only unmapped reads.",
"items": {
@@ -1625,20 +2427,23 @@
"exportUri": {
"description": "Required. A Google Cloud Storage URI for the exported BAM file.\nThe currently authenticated user must have write access to the new file.\nAn error will be returned if the URI already contains data.",
"type": "string"
- },
- "projectId": {
- "description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
- "type": "string"
}
},
- "id": "ExportReadGroupSetRequest",
- "description": "The read group set export request.",
- "type": "object"
+ "id": "ExportReadGroupSetRequest"
},
"CallSet": {
"description": "A call set is a collection of variant calls, typically for one sample. It\nbelongs to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
+ "created": {
+ "format": "int64",
+ "description": "The date this call set was created in milliseconds from the epoch.",
+ "type": "string"
+ },
+ "sampleId": {
+ "description": "The sample ID this call set corresponds to.",
+ "type": "string"
+ },
"name": {
"description": "The call set name.",
"type": "string"
@@ -1663,15 +2468,6 @@
"id": {
"description": "The server-generated call set ID, unique across all call sets.",
"type": "string"
- },
- "created": {
- "type": "string",
- "format": "int64",
- "description": "The date this call set was created in milliseconds from the epoch."
- },
- "sampleId": {
- "description": "The sample ID this call set corresponds to.",
- "type": "string"
}
},
"id": "CallSet"
@@ -1697,17 +2493,31 @@
"description": "The variant data import request.",
"type": "object",
"properties": {
+ "format": {
+ "description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported. Disclaimer: gzip VCF imports are currently much slower\nthan equivalent uncompressed VCF imports. For this reason, uncompressed\nVCF is currently recommended for imports with more than 1GB combined\nuncompressed size, or for time sensitive imports.",
+ "Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed."
+ ],
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "FORMAT_VCF",
+ "FORMAT_COMPLETE_GENOMICS"
+ ]
+ },
"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": {
+ "type": "string",
"enum": [
"INFO_MERGE_OPERATION_UNSPECIFIED",
"IGNORE_NEW",
"MOVE_TO_CALLS"
- ],
- "type": "string"
- }
+ ]
+ },
+ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
+ "type": "object"
},
"sourceUris": {
"description": "A list of URIs referencing variant files in Google Cloud Storage. URIs can\ninclude wildcards [as described\nhere](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).\nNote that recursive wildcards ('**') are not supported.",
@@ -1723,27 +2533,42 @@
"normalizeReferenceNames": {
"description": "Convert reference names to the canonical representation.\nhg19 haploytypes (those reference names containing \"_hap\")\nare not modified in any way.\nAll other reference names are modified according to the following rules:\nThe reference name is capitalized.\nThe \"chr\" prefix is dropped for all autosomes and sex chromsomes.\nFor example \"chr17\" becomes \"17\" and \"chrX\" becomes \"X\".\nAll mitochondrial chromosomes (\"chrM\", \"chrMT\", etc) become \"MT\".",
"type": "boolean"
- },
- "format": {
- "enumDescriptions": [
- "",
- "VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported. Disclaimer: gzip VCF imports are currently much slower\nthan equivalent uncompressed VCF imports. For this reason, uncompressed\nVCF is currently recommended for imports with more than 1GB combined\nuncompressed size, or for time sensitive imports.",
- "Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed."
- ],
- "enum": [
- "FORMAT_UNSPECIFIED",
- "FORMAT_VCF",
- "FORMAT_COMPLETE_GENOMICS"
- ],
- "description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.",
- "type": "string"
}
},
"id": "ImportVariantsRequest"
},
+ "ListCoverageBucketsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
+ "bucketWidth": {
+ "format": "int64",
+ "description": "The length of each coverage bucket in base pairs. Note that buckets at the\nend of a reference sequence may be shorter. This value is omitted if the\nbucket width is infinity (the default behaviour, with no range or\n`targetBucketWidth`).",
+ "type": "string"
+ },
+ "coverageBuckets": {
+ "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0\noverlapping reads is not returned. A bucket never crosses more than one\nreference sequence. Each bucket has width `bucketWidth`, unless\nits end is the end of the reference sequence.",
+ "items": {
+ "$ref": "CoverageBucket"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListCoverageBucketsResponse"
+ },
"VariantAnnotation": {
"type": "object",
"properties": {
+ "transcriptIds": {
+ "description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"type": {
"enumDescriptions": [
"",
@@ -1777,22 +2602,6 @@
"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": [
@@ -1810,6 +2619,22 @@
"",
"",
"`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field."
+ ],
+ "enum": [
+ "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
+ "CLINICAL_SIGNIFICANCE_OTHER",
+ "UNCERTAIN",
+ "BENIGN",
+ "LIKELY_BENIGN",
+ "LIKELY_PATHOGENIC",
+ "PATHOGENIC",
+ "DRUG_RESPONSE",
+ "HISTOCOMPATIBILITY",
+ "CONFERS_SENSITIVITY",
+ "RISK_FACTOR",
+ "ASSOCIATION",
+ "PROTECTIVE",
+ "MULTIPLE_REPORTED"
]
},
"conditions": {
@@ -1820,8 +2645,6 @@
"type": "array"
},
"effect": {
- "description": "Effect of the variant on the coding sequence.",
- "type": "string",
"enumDescriptions": [
"",
"`EFFECT_OTHER` should be used when no other Effect\nwill suffice.",
@@ -1843,40 +2666,13 @@
"STOP_GAIN",
"STOP_LOSS",
"SPLICE_SITE_DISRUPTION"
- ]
- },
- "transcriptIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created."
+ ],
+ "description": "Effect of the variant on the coding sequence.",
+ "type": "string"
}
},
"id": "VariantAnnotation"
},
- "ListCoverageBucketsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
- "bucketWidth": {
- "format": "int64",
- "description": "The length of each coverage bucket in base pairs. Note that buckets at the\nend of a reference sequence may be shorter. This value is omitted if the\nbucket width is infinity (the default behaviour, with no range or\n`targetBucketWidth`).",
- "type": "string"
- },
- "coverageBuckets": {
- "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0\noverlapping reads is not returned. A bucket never crosses more than one\nreference sequence. Each bucket has width `bucketWidth`, unless\nits end is the end of the reference sequence.",
- "items": {
- "$ref": "CoverageBucket"
- },
- "type": "array"
- }
- },
- "id": "ListCoverageBucketsResponse",
- "type": "object"
- },
"ExportVariantSetRequest": {
"description": "The variant data export request.",
"type": "object",
@@ -1918,23 +2714,6 @@
"SearchAnnotationsRequest": {
"type": "object",
"properties": {
- "referenceName": {
- "description": "The name of the reference to query, within the reference set associated\nwith this query.",
- "type": "string"
- },
- "referenceId": {
- "description": "The ID of the reference to query.",
- "type": "string"
- },
- "end": {
- "format": "int64",
- "description": "The end position of the range on the reference, 0-based exclusive. If\nreferenceId or\nreferenceName\nmust be specified, Defaults to the length of the reference.",
- "type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
@@ -1951,6 +2730,23 @@
"type": "string"
},
"type": "array"
+ },
+ "referenceName": {
+ "description": "The name of the reference to query, within the reference set associated\nwith this query.",
+ "type": "string"
+ },
+ "referenceId": {
+ "description": "The ID of the reference to query.",
+ "type": "string"
+ },
+ "end": {
+ "format": "int64",
+ "description": "The end position of the range on the reference, 0-based exclusive. If\nreferenceId or\nreferenceName\nmust be specified, Defaults to the length of the reference.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
}
},
"id": "SearchAnnotationsRequest"
@@ -1959,6 +2755,10 @@
"description": "An event that occurred during an Operation.",
"type": "object",
"properties": {
+ "description": {
+ "description": "Required description of event.",
+ "type": "string"
+ },
"endTime": {
"format": "google-datetime",
"description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
@@ -1968,15 +2768,12 @@
"format": "google-datetime",
"description": "Optional time of when event started.",
"type": "string"
- },
- "description": {
- "description": "Required description of event.",
- "type": "string"
}
},
"id": "OperationEvent"
},
"CodingSequence": {
+ "type": "object",
"properties": {
"start": {
"format": "int64",
@@ -1989,46 +2786,45 @@
"type": "string"
}
},
- "id": "CodingSequence",
- "type": "object"
- },
- "SearchReferencesResponse": {
- "properties": {
- "references": {
- "items": {
- "$ref": "Reference"
- },
- "type": "array",
- "description": "The matching references."
- },
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- }
- },
- "id": "SearchReferencesResponse",
- "type": "object"
- },
- "GetIamPolicyRequest": {
- "properties": {},
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object"
+ "id": "CodingSequence"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
+ "type": "array"
}
},
"id": "TestIamPermissionsResponse"
},
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
+ "SearchReferencesResponse": {
+ "type": "object",
+ "properties": {
+ "references": {
+ "description": "The matching references.",
+ "items": {
+ "$ref": "Reference"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ }
+ },
+ "id": "SearchReferencesResponse"
+ },
"SearchAnnotationSetsRequest": {
"type": "object",
"properties": {
@@ -2051,14 +2847,14 @@
"types": {
"description": "If specified, only annotation sets that have any of these types are\nreturned.",
"items": {
- "type": "string",
"enum": [
"ANNOTATION_TYPE_UNSPECIFIED",
"GENERIC",
"VARIANT",
"GENE",
"TRANSCRIPT"
- ]
+ ],
+ "type": "string"
},
"type": "array",
"enumDescriptions": [
@@ -2098,29 +2894,6 @@
},
"id": "SearchReadGroupSetsResponse"
},
- "LinearAlignment": {
- "description": "A linear alignment can be represented by one CIGAR string. Describes the\nmapped position and local alignment of the read to the reference.",
- "type": "object",
- "properties": {
- "cigar": {
- "description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
- "items": {
- "$ref": "CigarUnit"
- },
- "type": "array"
- },
- "position": {
- "description": "The position of this alignment.",
- "$ref": "Position"
- },
- "mappingQuality": {
- "format": "int32",
- "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
- "type": "integer"
- }
- },
- "id": "LinearAlignment"
- },
"SearchReferencesRequest": {
"type": "object",
"properties": {
@@ -2154,13 +2927,33 @@
},
"id": "SearchReferencesRequest"
},
- "Dataset": {
+ "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": {
- "name": {
- "description": "The dataset name.",
- "type": "string"
+ "mappingQuality": {
+ "format": "int32",
+ "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
+ "type": "integer"
},
+ "cigar": {
+ "description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
+ "items": {
+ "$ref": "CigarUnit"
+ },
+ "type": "array"
+ },
+ "position": {
+ "description": "The position of this alignment.",
+ "$ref": "Position"
+ }
+ },
+ "id": "LinearAlignment"
+ },
+ "Dataset": {
+ "description": "A Dataset is a collection of genomic data.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
"projectId": {
"description": "The Google Cloud project ID that this dataset belongs to.",
"type": "string"
@@ -2173,12 +2966,16 @@
"format": "google-datetime",
"description": "The time this dataset was created, in seconds from the epoch.",
"type": "string"
+ },
+ "name": {
+ "description": "The dataset name.",
+ "type": "string"
}
},
- "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)"
+ "id": "Dataset"
},
"ImportVariantsResponse": {
+ "description": "The variant data import response.",
"type": "object",
"properties": {
"callSetIds": {
@@ -2189,8 +2986,7 @@
"type": "array"
}
},
- "id": "ImportVariantsResponse",
- "description": "The variant data import response."
+ "id": "ImportVariantsResponse"
},
"ReadGroup": {
"description": "A read group is all the data that's processed the same way by the sequencer.",
@@ -2253,10 +3049,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": {
- "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.",
"items": {
@@ -2265,8 +3057,8 @@
"type": "array"
},
"filename": {
- "type": "string",
- "description": "The filename of the original source file for this read group set, if any."
+ "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.",
@@ -2289,6 +3081,10 @@
"id": {
"description": "The server-generated read group set ID, unique for all read group sets.",
"type": "string"
+ },
+ "datasetId": {
+ "description": "The dataset to which this read group set belongs.",
+ "type": "string"
}
},
"id": "ReadGroupSet"
@@ -2318,18 +3114,18 @@
"id": "Empty"
},
"Entry": {
- "id": "Entry",
"type": "object",
"properties": {
"annotation": {
- "$ref": "Annotation",
- "description": "The created annotation, if creation was successful."
+ "description": "The created annotation, if creation was successful.",
+ "$ref": "Annotation"
},
"status": {
- "$ref": "Status",
- "description": "The creation status."
+ "description": "The creation status.",
+ "$ref": "Status"
}
- }
+ },
+ "id": "Entry"
},
"Position": {
"description": "An abstraction for referring to a genomic position, in relation to some\nalready known reference. For now, represents a genomic position as a\nreference name, a base number on that reference (0-based), and a\ndetermination of forward or reverse strand.",
@@ -2352,7 +3148,6 @@
"id": "Position"
},
"SearchReferenceSetsResponse": {
- "id": "SearchReferenceSetsResponse",
"type": "object",
"properties": {
"referenceSets": {
@@ -2366,20 +3161,13 @@
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
}
- }
+ },
+ "id": "SearchReferenceSetsResponse"
},
"SearchCallSetsRequest": {
"description": "The call set search request.",
"type": "object",
"properties": {
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "name": {
- "description": "Only return call sets for which a substring of the name matches this\nstring.",
- "type": "string"
- },
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
@@ -2391,6 +3179,14 @@
"type": "string"
},
"type": "array"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Only return call sets for which a substring of the name matches this\nstring.",
+ "type": "string"
}
},
"id": "SearchCallSetsRequest"
@@ -2404,8 +3200,6 @@
"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.",
@@ -2415,18 +3209,20 @@
"PARTITION_STRATEGY_UNSPECIFIED",
"PER_FILE_PER_SAMPLE",
"MERGE_ALL"
- ]
+ ],
+ "description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.",
+ "type": "string"
},
"datasetId": {
"description": "Required. The ID of the dataset these read group sets will belong to. The\ncaller must have WRITE permissions to this dataset.",
"type": "string"
},
"sourceUris": {
+ "description": "A list of URIs pointing at [BAM\nfiles](https://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URIs can include wildcards (*), but do not add or remove\nmatching files before import has completed.\n\nNote that Google Cloud Storage object listing is only eventually\nconsistent: files added may be not be immediately visible to\neveryone. Thus, if using a wildcard it is preferable not to start\nthe import immediately after the files are created.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "A list of URIs pointing at [BAM\nfiles](https://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URIs can include wildcards (*), but do not add or remove\nmatching files before import has completed.\n\nNote that Google Cloud Storage object listing is only eventually\nconsistent: files added may be not be immediately visible to\neveryone. Thus, if using a wildcard it is preferable not to start\nthe import immediately after the files are created."
+ "type": "array"
}
},
"id": "ImportReadGroupSetsRequest"
@@ -2436,9 +3232,9 @@
"type": "object",
"properties": {
"etag": {
- "type": "string",
"format": "byte",
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly."
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "type": "string"
},
"version": {
"format": "int32",
@@ -2455,30 +3251,103 @@
},
"id": "Policy"
},
+ "Annotation": {
+ "description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.",
+ "type": "object",
+ "properties": {
+ "referenceName": {
+ "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
+ "type": "string"
+ },
+ "info": {
+ "additionalProperties": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
+ },
+ "type": {
+ "description": "The data type for this annotation. Must match the containing annotation\nset's type.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
+ "A `VARIANT` annotation type.",
+ "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
+ "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
+ ],
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ]
+ },
+ "end": {
+ "format": "int64",
+ "description": "The end position of the range on the reference, 0-based exclusive.",
+ "type": "string"
+ },
+ "transcript": {
+ "$ref": "Transcript",
+ "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`."
+ },
+ "start": {
+ "format": "int64",
+ "description": "The start position of the range on the reference, 0-based inclusive.",
+ "type": "string"
+ },
+ "annotationSetId": {
+ "description": "The annotation set to which this annotation belongs.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The display name of this annotation.",
+ "type": "string"
+ },
+ "variant": {
+ "$ref": "VariantAnnotation",
+ "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`."
+ },
+ "id": {
+ "description": "The server-generated annotation ID, unique across all annotations.",
+ "type": "string"
+ },
+ "referenceId": {
+ "description": "The ID of the Google Genomics reference associated with this range.",
+ "type": "string"
+ },
+ "reverseStrand": {
+ "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.",
+ "type": "boolean"
+ }
+ },
+ "id": "Annotation"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
"SearchReadsRequest": {
"description": "The read search request.",
"type": "object",
"properties": {
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
- "type": "integer"
- },
- "start": {
- "format": "int64",
- "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified.",
- "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`.",
"items": {
"type": "string"
},
- "type": "array",
- "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"
},
"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`.",
@@ -2495,99 +3364,37 @@
"pageToken": {
"description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
"type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
+ "type": "integer"
+ },
+ "start": {
+ "format": "int64",
+ "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified.",
+ "type": "string"
}
},
"id": "SearchReadsRequest"
},
- "CancelOperationRequest": {
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
- "type": "object"
- },
- "Annotation": {
- "description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.",
+ "RuntimeMetadata": {
+ "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
"type": "object",
"properties": {
- "transcript": {
- "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`.",
- "$ref": "Transcript"
- },
- "start": {
- "format": "int64",
- "description": "The start position of the range on the reference, 0-based inclusive.",
- "type": "string"
- },
- "annotationSetId": {
- "description": "The annotation set to which this annotation belongs.",
- "type": "string"
- },
- "name": {
- "description": "The display name of this annotation.",
- "type": "string"
- },
- "variant": {
- "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`.",
- "$ref": "VariantAnnotation"
- },
- "referenceId": {
- "description": "The ID of the Google Genomics reference associated with this range.",
- "type": "string"
- },
- "id": {
- "description": "The server-generated annotation ID, unique across all annotations.",
- "type": "string"
- },
- "reverseStrand": {
- "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.",
- "type": "boolean"
- },
- "referenceName": {
- "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
- "type": "string"
- },
- "info": {
- "additionalProperties": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "type": {
- "enumDescriptions": [
- "",
- "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
- "A `VARIANT` annotation type.",
- "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
- "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ],
- "enum": [
- "ANNOTATION_TYPE_UNSPECIFIED",
- "GENERIC",
- "VARIANT",
- "GENE",
- "TRANSCRIPT"
- ],
- "description": "The data type for this annotation. Must match the containing annotation\nset's type.",
- "type": "string"
- },
- "end": {
- "format": "int64",
- "description": "The end position of the range on the reference, 0-based exclusive.",
- "type": "string"
+ "computeEngine": {
+ "description": "Execution information specific to Google Compute Engine.",
+ "$ref": "ComputeEngine"
}
},
- "id": "Annotation"
+ "id": "RuntimeMetadata"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "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": {
@@ -2603,41 +3410,30 @@
"type": "string"
},
"error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
},
"metadata": {
+ "description": "An OperationMetadata object. This will always be returned with the Operation.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "An OperationMetadata object. This will always be returned with the Operation.",
- "type": "object"
+ }
}
},
"id": "Operation"
},
- "RuntimeMetadata": {
- "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
- "type": "object",
- "properties": {
- "computeEngine": {
- "$ref": "ComputeEngine",
- "description": "Execution information specific to Google Compute Engine."
- }
- },
- "id": "RuntimeMetadata"
- },
"ImportReadGroupSetsResponse": {
"description": "The read group set import response.",
"type": "object",
"properties": {
"readGroupSetIds": {
+ "description": "IDs of the read group sets that were created.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "IDs of the read group sets that were created."
+ "type": "array"
}
},
"id": "ImportReadGroupSetsResponse"
@@ -2646,15 +3442,19 @@
"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": {
+ "description": "If this field is present, this variant call's genotype ordering implies\nthe phase of the bases and is consistent with any other variant calls in\nthe same reference sequence which have the same phaseset value.\nWhen importing data from VCF, if the genotype data was phased but no\nphase set was specified this field will be set to `*`.",
+ "type": "string"
+ },
"info": {
+ "description": "A map of additional variant call information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
- },
- "description": "A map of additional variant call information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
+ }
},
"callSetName": {
"description": "The name of the call set this variant call belongs to.",
@@ -2663,8 +3463,8 @@
"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`.",
"items": {
- "type": "number",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"type": "array"
},
@@ -2675,60 +3475,60 @@
"genotype": {
"description": "The genotype of this variant call. Each value represents either the value\nof the `referenceBases` field or a 1-based index into\n`alternateBases`. If a variant had a `referenceBases`\nvalue of `T` and an `alternateBases`\nvalue of `[\"A\", \"C\"]`, and the `genotype` was\n`[2, 1]`, that would mean the call\nrepresented the heterozygous value `CA` for this variant.\nIf the `genotype` was instead `[0, 1]`, the\nrepresented value would be `TA`. Ordering of the\ngenotype values is important if the `phaseset` is present.\nIf a genotype is not called (that is, a `.` is present in the\nGT string) -1 is returned.",
"items": {
- "type": "integer",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"type": "array"
- },
- "phaseset": {
- "description": "If this field is present, this variant call's genotype ordering implies\nthe phase of the bases and is consistent with any other variant calls in\nthe same reference sequence which have the same phaseset value.\nWhen importing data from VCF, if the genotype data was phased but no\nphase set was specified this field will be set to `*`.",
- "type": "string"
}
},
"id": "VariantCall"
},
"SearchVariantsResponse": {
+ "description": "The variant search response.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
"variants": {
"description": "The list of matching Variants.",
"items": {
"$ref": "Variant"
},
"type": "array"
- }
- },
- "id": "SearchVariantsResponse",
- "description": "The variant search response.",
- "type": "object"
- },
- "ListBasesResponse": {
- "type": "object",
- "properties": {
- "sequence": {
- "description": "A substring of the bases that make up this reference.",
- "type": "string"
- },
- "offset": {
- "type": "string",
- "format": "int64",
- "description": "The offset position (0-based) of the given `sequence` from the\nstart of this `Reference`. This value will differ for each page\nin a paginated request."
},
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
}
},
+ "id": "SearchVariantsResponse"
+ },
+ "ListBasesResponse": {
+ "type": "object",
+ "properties": {
+ "offset": {
+ "format": "int64",
+ "description": "The offset position (0-based) of the given `sequence` from the\nstart of this `Reference`. This value will differ for each page\nin a paginated request.",
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
+ "sequence": {
+ "description": "A substring of the bases that make up this reference.",
+ "type": "string"
+ }
+ },
"id": "ListBasesResponse"
},
"Status": {
- "id": "Status",
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
@@ -2743,18 +3543,9 @@
"type": "object"
},
"type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
}
- }
- },
- "UndeleteDatasetRequest": {
- "type": "object",
- "properties": {},
- "id": "UndeleteDatasetRequest"
+ },
+ "id": "Status"
},
"Binding": {
"description": "Associates `members` with a `role`.",
@@ -2768,17 +3559,26 @@
"type": "array"
},
"role": {
- "type": "string",
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
}
},
"id": "Binding"
},
+ "UndeleteDatasetRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteDatasetRequest"
+ },
"Range": {
- "id": "Range",
"description": "A 0-based half-open genomic coordinate range for search requests.",
"type": "object",
"properties": {
+ "end": {
+ "format": "int64",
+ "description": "The end position of the range on the reference, 0-based exclusive.",
+ "type": "string"
+ },
"referenceName": {
"description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`.",
"type": "string"
@@ -2787,18 +3587,26 @@
"format": "int64",
"description": "The start position of the range on the reference, 0-based inclusive.",
"type": "string"
- },
- "end": {
- "format": "int64",
- "description": "The end position of the range on the reference, 0-based exclusive.",
- "type": "string"
}
- }
+ },
+ "id": "Range"
},
"VariantSet": {
"description": "A variant set is a collection of call sets and variants. It contains summary\nstatistics of those contents. A variant set belongs to a dataset.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
+ "description": {
+ "description": "A textual description of this variant set.",
+ "type": "string"
+ },
+ "datasetId": {
+ "description": "The dataset to which this variant set belongs.",
+ "type": "string"
+ },
+ "name": {
+ "description": "User-specified, mutable name.",
+ "type": "string"
+ },
"referenceSetId": {
"description": "The reference set to which the variant set is mapped. The reference set\ndescribes the alignment provenance of the variant set, while the\n`referenceBounds` describe the shape of the actual variant data. The\nreference set's reference names are a superset of those found in the\n`referenceBounds`.\n\nFor example, given a variant set that is mapped to the GRCh38 reference set\nand contains a single variant on reference 'X', `referenceBounds` would\ncontain only an entry for 'X', while the associated reference set\nenumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.",
"type": "string"
@@ -2820,18 +3628,6 @@
"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": {
- "type": "string",
- "description": "The dataset to which this variant set belongs."
- },
- "name": {
- "description": "User-specified, mutable name.",
- "type": "string"
}
},
"id": "VariantSet"
@@ -2853,62 +3649,73 @@
"description": "ReferenceBound records an upper bound for the starting coordinate of\nvariants in a particular reference.",
"type": "object",
"properties": {
- "referenceName": {
- "description": "The name of the reference associated with this reference bound.",
- "type": "string"
- },
"upperBound": {
"format": "int64",
"description": "An upper bound (inclusive) on the starting coordinate of any\nvariant in the reference sequence.",
"type": "string"
+ },
+ "referenceName": {
+ "description": "The name of the reference associated with this reference bound.",
+ "type": "string"
}
},
"id": "ReferenceBound"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations."
+ "id": "ListOperationsResponse"
},
"Variant": {
"description": "A variant represents a change in DNA sequence relative to a reference\nsequence. For example, a variant could represent a SNP or an insertion.\nVariants belong to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a determination of genotype with\nrespect to that variant. For example, a call might assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sample named NA12345. A call\nbelongs to a call set, which contains related calls typically from one\nsample.",
"type": "object",
"properties": {
+ "id": {
+ "description": "The server-generated variant ID, unique across all variants.",
+ "type": "string"
+ },
"variantSetId": {
- "type": "string",
- "description": "The ID of the variant set this variant belongs to."
+ "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": {
+ "description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object",
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
- },
- "description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values)."
+ }
},
"referenceBases": {
"description": "The reference bases for this variant. They start at the given\nposition.",
"type": "string"
},
+ "names": {
+ "description": "Names for the variant, for example a RefSNP ID.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"alternateBases": {
"description": "The bases that appear instead of the reference bases.",
"items": {
@@ -2916,8 +3723,8 @@
},
"type": "array"
},
- "names": {
- "description": "Names for the variant, for example a RefSNP ID.",
+ "filter": {
+ "description": "A list of filters (normally quality filters) this variant has failed.\n`PASS` indicates this variant has passed all filters.",
"items": {
"type": "string"
},
@@ -2928,13 +3735,6 @@
"description": "The end position (0-based) of this variant. This corresponds to the first\nbase after the last base in the reference allele. So, the length of\nthe reference allele is (end - start). This is useful for variants\nthat don't explicitly give alternate bases, for example large deletions.",
"type": "string"
},
- "filter": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "A list of filters (normally quality filters) this variant has failed.\n`PASS` indicates this variant has passed all filters."
- },
"calls": {
"description": "The variant calls for this particular variant. Each one represents the\ndetermination of genotype with respect to this variant.",
"items": {
@@ -2956,10 +3756,6 @@
"format": "double",
"description": "A measure of how likely this variant is to be real.\nA higher value is better.",
"type": "number"
- },
- "id": {
- "description": "The server-generated variant ID, unique across all variants.",
- "type": "string"
}
},
"id": "Variant"
@@ -2968,820 +3764,34 @@
"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.",
"items": {
"$ref": "CallSet"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
}
},
"id": "SearchCallSetsResponse"
- },
- "SearchVariantsRequest": {
- "description": "The variant search request.",
- "type": "object",
- "properties": {
- "maxCalls": {
- "type": "integer",
- "format": "int32",
- "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."
- },
- "pageToken": {
- "type": "string",
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response."
- },
- "pageSize": {
- "type": "integer",
- "format": "int32",
- "description": "The maximum number of variants to return in a single page. If unspecified,\ndefaults to 5000. The maximum value is 10000."
- },
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "variantName": {
- "description": "Only return variants which have exactly this name.",
- "type": "string"
- },
- "start": {
- "type": "string",
- "format": "int64",
- "description": "The beginning of the window (0-based, inclusive) for which\noverlapping variants should be returned. If unspecified, defaults to 0."
- },
- "referenceName": {
- "description": "Required. Only return variants in this reference sequence.",
- "type": "string"
- },
- "variantSetIds": {
- "description": "At most one variant set ID must be provided. Only variants from this\nvariant set will be returned. If omitted, a call set id must be included in\nthe request.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "end": {
- "format": "int64",
- "description": "The end of the window, 0-based exclusive. If unspecified or 0, defaults to\nthe length of the reference.",
- "type": "string"
- }
- },
- "id": "SearchVariantsRequest"
- },
- "OperationMetadata": {
- "id": "OperationMetadata",
- "description": "Metadata describing an Operation.",
- "type": "object",
- "properties": {
- "runtimeMetadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Runtime metadata on this Operation.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
- "type": "object"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "The time at which the job was submitted to the Genomics service.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Cloud Project in which the job is scoped.",
- "type": "string"
- },
- "clientId": {
- "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
- "type": "string"
- },
- "events": {
- "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
- "items": {
- "$ref": "OperationEvent"
- },
- "type": "array"
- },
- "endTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The time at which the job stopped running."
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The time at which the job began to run.",
- "type": "string"
- },
- "request": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
- "type": "object"
- }
- }
- },
- "SearchReadGroupSetsRequest": {
- "description": "The read group set search request.",
- "type": "object",
- "properties": {
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 1024.",
- "type": "integer"
- },
- "datasetIds": {
- "description": "Restricts this query to read group sets within the given datasets. At least\none ID must be provided.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "name": {
- "description": "Only return read group sets for which a substring of the name matches this\nstring.",
- "type": "string"
- }
- },
- "id": "SearchReadGroupSetsRequest"
- },
- "SearchAnnotationsResponse": {
- "type": "object",
- "properties": {
- "annotations": {
- "description": "The matching annotations.",
- "items": {
- "$ref": "Annotation"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- }
- },
- "id": "SearchAnnotationsResponse"
- },
- "ClinicalCondition": {
- "type": "object",
- "properties": {
- "conceptId": {
- "description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/",
- "type": "string"
- },
- "names": {
- "description": "A set of names for the condition.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "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.",
- "items": {
- "$ref": "ExternalId"
- },
- "type": "array"
- }
- },
- "id": "ClinicalCondition"
- },
- "SearchReadsResponse": {
- "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."
- },
- "alignments": {
- "items": {
- "$ref": "Read"
- },
- "type": "array",
- "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."
- }
- },
- "id": "SearchReadsResponse",
- "description": "The read search response.",
- "type": "object"
- },
- "Program": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The display name of the program. This is typically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'.",
- "type": "string"
- },
- "prevProgramId": {
- "description": "The ID of the program run before this one.",
- "type": "string"
- },
- "commandLine": {
- "description": "The command line used to run this program.",
- "type": "string"
- },
- "version": {
- "description": "The version of the program run.",
- "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"
- }
- },
- "id": "Program"
- },
- "ComputeEngine": {
- "id": "ComputeEngine",
- "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
- "type": "object",
- "properties": {
- "instanceName": {
- "description": "The instance on which the operation is running.",
- "type": "string"
- },
- "zone": {
- "description": "The availability zone in which the instance resides.",
- "type": "string"
- },
- "diskNames": {
- "description": "The names of the disks that were created for this pipeline.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "machineType": {
- "type": "string",
- "description": "The machine type of the instance."
- }
- }
- },
- "CoverageBucket": {
- "description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
- "type": "object",
- "properties": {
- "meanCoverage": {
- "format": "float",
- "description": "The average number of reads which are aligned to each individual\nreference base in this bucket.",
- "type": "number"
- },
- "range": {
- "$ref": "Range",
- "description": "The genomic coordinate range spanned by this bucket."
- }
- },
- "id": "CoverageBucket"
- },
- "ExternalId": {
- "type": "object",
- "properties": {
- "id": {
- "description": "The id used by the source of this data.",
- "type": "string"
- },
- "sourceName": {
- "description": "The name of the source of this data.",
- "type": "string"
- }
- },
- "id": "ExternalId"
- },
- "SearchVariantSetsRequest": {
- "description": "The search variant sets request.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
- "type": "integer"
- },
- "datasetIds": {
- "description": "Exactly one dataset ID must be provided here. Only variant sets which\nbelong to this dataset will be returned.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "SearchVariantSetsRequest"
- },
- "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": {
- "value": {
- "type": "string",
- "description": "The value field for simple metadata"
- },
- "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": {
- "type": "string",
- "description": "The number of values that can be included in a field described by this\nmetadata."
- },
- "key": {
- "description": "The top-level key.",
- "type": "string"
- },
- "description": {
- "description": "A textual description of this metadata.",
- "type": "string"
- },
- "info": {
- "additionalProperties": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "type": {
- "description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String.",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "FLAG",
- "CHARACTER",
- "STRING"
- ]
- }
- },
- "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": {
- "id": {
- "type": "string",
- "description": "The server-generated reference ID, unique across all references."
- },
- "length": {
- "type": "string",
- "format": "int64",
- "description": "The length of this reference's sequence."
- },
- "sourceAccessions": {
- "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405.26`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "sourceUri": {
- "description": "The URI from which the sequence was obtained. Typically specifies a FASTA\nformat file.",
- "type": "string"
- },
- "ncbiTaxonId": {
- "format": "int32",
- "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.",
- "type": "integer"
- },
- "name": {
- "description": "The name of this reference, for example `22`.",
- "type": "string"
- },
- "md5checksum": {
- "description": "MD5 of the upper-case sequence excluding all whitespace characters (this\nis equivalent to SQ:M5 in SAM). This value is represented in lower case\nhexadecimal format.",
- "type": "string"
- }
- },
- "id": "Reference"
- },
- "SearchReferenceSetsRequest": {
- "properties": {
- "assemblyId": {
- "description": "If present, return reference sets for which a substring of their\n`assemblyId` matches this string (case insensitive).",
- "type": "string"
- },
- "md5checksums": {
- "description": "If present, return reference sets for which the\nmd5checksum matches exactly.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pageToken": {
- "type": "string",
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response."
- },
- "accessions": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "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`."
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
- "type": "integer"
- }
- },
- "id": "SearchReferenceSetsRequest",
- "type": "object"
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- }
- },
- "id": "SetIamPolicyRequest"
- },
- "MergeVariantsRequest": {
- "type": "object",
- "properties": {
- "variantSetId": {
- "description": "The destination variant set.",
- "type": "string"
- },
- "variants": {
- "description": "The variants to be merged with existing variants.",
- "items": {
- "$ref": "Variant"
- },
- "type": "array"
- },
- "infoMergeConfig": {
- "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "enum": [
- "INFO_MERGE_OPERATION_UNSPECIFIED",
- "IGNORE_NEW",
- "MOVE_TO_CALLS"
- ]
- }
- }
- },
- "id": "MergeVariantsRequest"
- },
- "Read": {
- "description": "A read alignment describes a linear alignment of a string of DNA to a\nreference sequence, in addition to metadata\nabout the fragment (the molecule of DNA sequenced) and the read (the bases\nwhich were read by the sequencer). A read is equivalent to a line in a SAM\nfile. A read belongs to exactly one read group and exactly one\nread group set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\n### Reverse-stranded reads\n\nMapped reads (reads having a non-null `alignment`) can be aligned to either\nthe forward or the reverse strand of their associated reference. Strandedness\nof a mapped read is encoded by `alignment.position.reverseStrand`.\n\nIf we consider the reference to be a forward-stranded coordinate space of\n`[0, reference.length)` with `0` as the left-most position and\n`reference.length` as the right-most position, reads are always aligned left\nto right. That is, `alignment.position.position` always refers to the\nleft-most reference coordinate and `alignment.cigar` describes the alignment\nof this read to the reference from left to right. All per-base fields such as\n`alignedSequence` and `alignedQuality` share this same left-to-right\norientation; this is true of reads which are aligned to either strand. For\nreverse-stranded reads, this means that `alignedSequence` is the reverse\ncomplement of the bases that were originally reported by the sequencing\nmachine.\n\n### Generating a reference-aligned sequence string\n\nWhen interacting with mapped reads, it's often useful to produce a string\nrepresenting the local alignment of the read to reference. The following\npseudocode demonstrates one way of doing this:\n\n out = \"\"\n offset = 0\n for c in read.alignment.cigar {\n switch c.operation {\n case \"ALIGNMENT_MATCH\", \"SEQUENCE_MATCH\", \"SEQUENCE_MISMATCH\":\n out += read.alignedSequence[offset:offset+c.operationLength]\n offset += c.operationLength\n break\n case \"CLIP_SOFT\", \"INSERT\":\n offset += c.operationLength\n break\n case \"PAD\":\n out += repeat(\"*\", c.operationLength)\n break\n case \"DELETE\":\n out += repeat(\"-\", c.operationLength)\n break\n case \"SKIP\":\n out += repeat(\" \", c.operationLength)\n break\n case \"CLIP_HARD\":\n break\n }\n }\n return out\n\n### Converting to SAM's CIGAR string\n\nThe following pseudocode generates a SAM CIGAR string from the\n`cigar` field. Note that this is a lossy conversion\n(`cigar.referenceSequence` is lost).\n\n cigarMap = {\n \"ALIGNMENT_MATCH\": \"M\",\n \"INSERT\": \"I\",\n \"DELETE\": \"D\",\n \"SKIP\": \"N\",\n \"CLIP_SOFT\": \"S\",\n \"CLIP_HARD\": \"H\",\n \"PAD\": \"P\",\n \"SEQUENCE_MATCH\": \"=\",\n \"SEQUENCE_MISMATCH\": \"X\",\n }\n cigarStr = \"\"\n for c in read.alignment.cigar {\n cigarStr += c.operationLength + cigarMap[c.operation]\n }\n return cigarStr",
- "type": "object",
- "properties": {
- "id": {
- "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
- "type": "string"
- },
- "numberReads": {
- "format": "int32",
- "description": "The number of reads in the fragment (extension to SAM flag 0x1).",
- "type": "integer"
- },
- "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."
- },
- "fragmentName": {
- "description": "The fragment name. Equivalent to QNAME (query template name) in SAM.",
- "type": "string"
- },
- "readGroupSetId": {
- "description": "The ID of the read group set this read belongs to. A read belongs to\nexactly one read group set.",
- "type": "string"
- },
- "duplicateFragment": {
- "description": "The fragment is a PCR or optical duplicate (SAM flag 0x400).",
- "type": "boolean"
- },
- "readNumber": {
- "type": "integer",
- "format": "int32",
- "description": "The read number in sequencing. 0-based and less than numberReads. This\nfield replaces SAM flag 0x40 and 0x80."
- },
- "alignedSequence": {
- "description": "The bases of the read sequence contained in this alignment record,\n**without CIGAR operations applied** (equivalent to SEQ in SAM).\n`alignedSequence` and `alignedQuality` may be\nshorter than the full read sequence and quality. This will occur if the\nalignment is part of a chimeric alignment, or if the read was trimmed. When\nthis occurs, the CIGAR for this read will begin/end with a hard clip\noperator that will indicate the length of the excised sequence.",
- "type": "string"
- },
- "readGroupId": {
- "description": "The ID of the read group this read belongs to. A read belongs to exactly\none read group. This is a server-generated ID which is distinct from SAM's\nRG tag (for that value, see\nReadGroup.name).",
- "type": "string"
- },
- "info": {
- "additionalProperties": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "nextMatePosition": {
- "$ref": "Position",
- "description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM."
- },
- "supplementaryAlignment": {
- "description": "Whether this alignment is supplementary. Equivalent to SAM flag 0x800.\nSupplementary alignments are used in the representation of a chimeric\nalignment. In a chimeric alignment, a read is split into multiple\nlinear alignments that map to different reference contigs. The first\nlinear alignment in the read will be designated as the representative\nalignment; the remaining linear alignments will be designated as\nsupplementary alignments. These alignments may have different mapping\nquality scores. In each linear alignment in a chimeric alignment, the read\nwill be hard clipped. The `alignedSequence` and\n`alignedQuality` fields in the alignment record will only\nrepresent the bases for its respective linear alignment.",
- "type": "boolean"
- },
- "properPlacement": {
- "description": "The orientation and the distance between reads from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2).",
- "type": "boolean"
- },
- "fragmentLength": {
- "format": "int32",
- "description": "The observed length of the fragment, equivalent to TLEN in SAM.",
- "type": "integer"
- },
- "failedVendorQualityChecks": {
- "description": "Whether this read did not pass filters, such as platform or vendor quality\ncontrols (SAM flag 0x200).",
- "type": "boolean"
- },
- "alignedQuality": {
- "description": "The quality of the read sequence contained in this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `alignedQuality` may be shorter than the full read\nsequence and quality. This will occur if the alignment is part of a\nchimeric alignment, or if the read was trimmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip operator that will indicate\nthe length of the excised sequence.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "alignment": {
- "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads.",
- "$ref": "LinearAlignment"
- }
- },
- "id": "Read"
- },
- "BatchCreateAnnotationsRequest": {
- "type": "object",
- "properties": {
- "annotations": {
- "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
- "items": {
- "$ref": "Annotation"
- },
- "type": "array"
- },
- "requestId": {
- "description": "A unique request ID which enables the server to detect duplicated requests.\nIf provided, duplicated requests will result in the same response; if not\nprovided, duplicated requests may result in duplicated data. For a given\nannotation set, callers should not reuse `request_id`s when writing\ndifferent batches of annotations - behavior in this case is undefined.\nA common approach is to use a UUID. For batch jobs where worker crashes are\na possibility, consider using some unique variant of a worker or run ID.",
- "type": "string"
- }
- },
- "id": "BatchCreateAnnotationsRequest"
- },
- "CigarUnit": {
- "description": "A single CIGAR operation.",
- "type": "object",
- "properties": {
- "operation": {
- "type": "string",
- "enumDescriptions": [
- "",
- "An alignment match indicates that a sequence can be aligned to the\nreference without evidence of an INDEL. Unlike the\n`SEQUENCE_MATCH` and `SEQUENCE_MISMATCH` operators,\nthe `ALIGNMENT_MATCH` operator does not indicate whether the\nreference and read sequences are an exact match. This operator is\nequivalent to SAM's `M`.",
- "The insert operator indicates that the read contains evidence of bases\nbeing inserted into the reference. This operator is equivalent to SAM's\n`I`.",
- "The delete operator indicates that the read contains evidence of bases\nbeing deleted from the reference. This operator is equivalent to SAM's\n`D`.",
- "The skip operator indicates that this read skips a long segment of the\nreference, but the bases have not been deleted. This operator is commonly\nused when working with RNA-seq data, where reads may skip long segments\nof the reference between exons. This operator is equivalent to SAM's\n`N`.",
- "The soft clip operator indicates that bases at the start/end of a read\nhave not been considered during alignment. This may occur if the majority\nof a read maps, except for low quality bases at the start/end of a read.\nThis operator is equivalent to SAM's `S`. Bases that are soft\nclipped will still be stored in the read.",
- "The hard clip operator indicates that bases at the start/end of a read\nhave been omitted from this alignment. This may occur if this linear\nalignment is part of a chimeric alignment, or if the read has been\ntrimmed (for example, during error correction or to trim poly-A tails for\nRNA-seq). This operator is equivalent to SAM's `H`.",
- "The pad operator indicates that there is padding in an alignment. This\noperator is equivalent to SAM's `P`.",
- "This operator indicates that this portion of the aligned sequence exactly\nmatches the reference. This operator is equivalent to SAM's `=`.",
- "This operator indicates that this portion of the aligned sequence is an\nalignment match to the reference, but a sequence mismatch. This can\nindicate a SNP or a read error. This operator is equivalent to SAM's\n`X`."
- ],
- "enum": [
- "OPERATION_UNSPECIFIED",
- "ALIGNMENT_MATCH",
- "INSERT",
- "DELETE",
- "SKIP",
- "CLIP_SOFT",
- "CLIP_HARD",
- "PAD",
- "SEQUENCE_MATCH",
- "SEQUENCE_MISMATCH"
- ]
- },
- "referenceSequence": {
- "description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.",
- "type": "string"
- },
- "operationLength": {
- "format": "int64",
- "description": "The number of genomic bases that the operation runs for. Required.",
- "type": "string"
- }
- },
- "id": "CigarUnit"
- },
- "ReferenceSet": {
- "description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object",
- "properties": {
- "referenceIds": {
- "description": "The IDs of the reference objects that are part of this set.\n`Reference.md5checksum` must be unique within this set.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "assemblyId": {
- "description": "Public id of this reference set, such as `GRCh37`.",
- "type": "string"
- },
- "md5checksum": {
- "description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
- "type": "string"
- },
- "id": {
- "description": "The server-generated reference set ID, unique across all reference sets.",
- "type": "string"
- },
- "sourceAccessions": {
- "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "description": {
- "description": "Free text description of this reference set.",
- "type": "string"
- },
- "sourceUri": {
- "description": "The URI from which the references were obtained.",
- "type": "string"
- },
- "ncbiTaxonId": {
- "format": "int32",
- "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
- "type": "integer"
- }
- },
- "id": "ReferenceSet"
- },
- "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": {
- "id": {
- "type": "string",
- "description": "The server-generated annotation set ID, unique across all annotation sets."
- },
- "datasetId": {
- "description": "The dataset to which this annotation set belongs.",
- "type": "string"
- },
- "sourceUri": {
- "description": "The source URI describing the file from which this annotation set was\ngenerated, if any.",
- "type": "string"
- },
- "name": {
- "description": "The display name for this annotation set.",
- "type": "string"
- },
- "referenceSetId": {
- "description": "The ID of the reference set that defines the coordinate space for this\nset's annotations.",
- "type": "string"
- },
- "info": {
- "additionalProperties": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "type": {
- "enumDescriptions": [
- "",
- "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
- "A `VARIANT` annotation type.",
- "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
- "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ],
- "enum": [
- "ANNOTATION_TYPE_UNSPECIFIED",
- "GENERIC",
- "VARIANT",
- "GENE",
- "TRANSCRIPT"
- ],
- "description": "The type of annotations contained within this set.",
- "type": "string"
- }
- },
- "id": "AnnotationSet"
- },
- "Transcript": {
- "id": "Transcript",
- "description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
- "type": "object",
- "properties": {
- "geneId": {
- "description": "The annotation ID of the gene from which this transcript is transcribed.",
- "type": "string"
- },
- "exons": {
- "description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
- "items": {
- "$ref": "Exon"
- },
- "type": "array"
- },
- "codingSequence": {
- "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA.",
- "$ref": "CodingSequence"
- }
- }
- },
- "Experiment": {
- "type": "object",
- "properties": {
- "sequencingCenter": {
- "description": "The sequencing center used as part of this experiment.",
- "type": "string"
- },
- "platformUnit": {
- "type": "string",
- "description": "The platform unit used as part of this experiment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the\n@RG PU field in the SAM spec."
- },
- "instrumentModel": {
- "description": "The instrument model used as part of this experiment. This maps to\nsequencing technology in the SAM spec.",
- "type": "string"
- },
- "libraryId": {
- "description": "A client-supplied library identifier; a library is a collection of DNA\nfragments which have been prepared for sequencing from a sample. This\nfield is important for quality control as error or bias can be introduced\nduring sample preparation.",
- "type": "string"
- }
- },
- "id": "Experiment"
- },
- "ListDatasetsResponse": {
- "description": "The dataset list response.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
- "datasets": {
- "description": "The list of matching Datasets.",
- "items": {
- "$ref": "Dataset"
- },
- "type": "array"
- }
- },
- "id": "ListDatasetsResponse"
}
},
+ "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://genomics.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/genomics": {
+ "description": "View and manage Genomics data"
+ },
"https://www.googleapis.com/auth/devstorage.read_write": {
"description": "Manage your data in Google Cloud Storage"
},
@@ -3793,25 +3803,15 @@
},
"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",
- "servicePath": "",
"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",
- "id": "genomics:v1",
- "documentationLink": "https://cloud.google.com/genomics",
- "revision": "20170819",
- "title": "Genomics API",
- "ownerName": "Google",
- "discoveryVersion": "v1"
+ "name": "genomics"
}
diff --git a/genomics/v1/genomics-gen.go b/genomics/v1/genomics-gen.go
index da51ba3..db7a754 100644
--- a/genomics/v1/genomics-gen.go
+++ b/genomics/v1/genomics-gen.go
@@ -1737,8 +1737,8 @@
type Operation struct {
// Done: If the value is `false`, it means the operation is still in
// progress.
- // If true, the operation is completed, and either `error` or `response`
- // is
+ // If `true`, the operation is completed, and either `error` or
+ // `response` is
// available.
Done bool `json:"done,omitempty"`
diff --git a/genomics/v1alpha2/genomics-api.json b/genomics/v1alpha2/genomics-api.json
index 3e4d007..0ddd4dc 100644
--- a/genomics/v1alpha2/genomics-api.json
+++ b/genomics/v1alpha2/genomics-api.json
@@ -1,66 +1,22 @@
{
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"pipelines": {
"methods": {
- "setOperationStatus": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "PUT",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines:setOperationStatus",
- "id": "genomics.pipelines.setOperationStatus",
- "path": "v1alpha2/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": {
+ "get": {
+ "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project.",
"httpMethod": "GET",
- "parameterOrder": [],
"response": {
- "$ref": "ControllerConfig"
+ "$ref": "Pipeline"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "operationId": {
- "description": "The operation to retrieve controller configuration for.",
- "type": "string",
- "location": "query"
- },
- "validationToken": {
- "location": "query",
- "format": "uint64",
- "type": "string"
- }
- },
- "flatPath": "v1alpha2/pipelines:getControllerConfig",
- "path": "v1alpha2/pipelines:getControllerConfig",
- "id": "genomics.pipelines.getControllerConfig",
- "description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users."
- },
- "delete": {
- "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project.",
- "httpMethod": "DELETE",
"parameterOrder": [
"pipelineId"
],
- "response": {
- "$ref": "Empty"
- },
"parameters": {
"pipelineId": {
"location": "path",
- "description": "Caller must have WRITE access to the project in which this pipeline\nis defined.",
+ "description": "Caller must have READ access to the project in which this pipeline\nis defined.",
"type": "string",
"required": true
}
@@ -71,14 +27,85 @@
],
"flatPath": "v1alpha2/pipelines/{pipelineId}",
"path": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.delete"
+ "id": "genomics.pipelines.get"
+ },
+ "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"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1alpha2/pipelines:setOperationStatus"
+ },
+ "getControllerConfig": {
+ "response": {
+ "$ref": "ControllerConfig"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "operationId": {
+ "location": "query",
+ "description": "The operation to retrieve controller configuration for.",
+ "type": "string"
+ },
+ "validationToken": {
+ "format": "uint64",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1alpha2/pipelines:getControllerConfig",
+ "id": "genomics.pipelines.getControllerConfig",
+ "path": "v1alpha2/pipelines:getControllerConfig",
+ "description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users."
+ },
+ "delete": {
+ "id": "genomics.pipelines.delete",
+ "path": "v1alpha2/pipelines/{pipelineId}",
+ "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "pipelineId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "pipelineId": {
+ "location": "path",
+ "description": "Caller must have WRITE access to the project in which this pipeline\nis defined.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1alpha2/pipelines/{pipelineId}"
},
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListPipelinesResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
"namePrefix": {
"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.",
@@ -86,9 +113,9 @@
"location": "query"
},
"pageToken": {
+ "location": "query",
"description": "Token to use to indicate where to start getting results.\nIf unspecified, returns the first page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -97,9 +124,9 @@
"type": "integer"
},
"projectId": {
- "location": "query",
"description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -107,17 +134,11 @@
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1alpha2/pipelines",
- "path": "v1alpha2/pipelines",
"id": "genomics.pipelines.list",
+ "path": "v1alpha2/pipelines",
"description": "Lists pipelines.\n\nCaller must have READ permission to the project."
},
"create": {
- "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.",
"response": {
"$ref": "Pipeline"
},
@@ -128,72 +149,53 @@
"https://www.googleapis.com/auth/genomics"
],
"parameters": {},
- "flatPath": "v1alpha2/pipelines"
+ "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": {
+ "path": "v1alpha2/pipelines:run",
+ "id": "genomics.pipelines.run",
+ "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.",
+ "request": {
+ "$ref": "RunPipelineRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Operation"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/genomics"
],
- "flatPath": "v1alpha2/pipelines:run",
- "id": "genomics.pipelines.run",
- "path": "v1alpha2/pipelines:run",
- "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.",
- "request": {
- "$ref": "RunPipelineRequest"
- }
- },
- "get": {
- "response": {
- "$ref": "Pipeline"
- },
- "parameterOrder": [
- "pipelineId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pipelineId": {
- "description": "Caller must have READ access to the project in which this pipeline\nis defined.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.get",
- "path": "v1alpha2/pipelines/{pipelineId}",
- "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project."
+ "flatPath": "v1alpha2/pipelines:run"
}
}
},
"operations": {
"methods": {
"cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"parameters": {
"name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
"description": "The name of the operation resource to be cancelled.",
"type": "string",
- "required": true,
- "pattern": "^operations/.+$",
- "location": "path"
+ "required": true
}
},
"scopes": [
@@ -201,14 +203,15 @@
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1alpha2/operations/{operationsId}:cancel",
- "path": "v1alpha2/{+name}:cancel",
"id": "genomics.operations.cancel",
+ "path": "v1alpha2/{+name}:cancel",
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
"request": {
"$ref": "CancelOperationRequest"
}
},
"get": {
+ "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"
},
@@ -231,24 +234,21 @@
},
"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."
+ "path": "v1alpha2/{+name}"
},
"list": {
- "description": "Lists operations that match the specified filter in the request.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"parameters": {
- "filter": {
- "location": "query",
- "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
- "type": "string"
- },
"pageToken": {
"description": "The standard list page token.",
"type": "string",
@@ -262,39 +262,62 @@
"required": true
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
"flatPath": "v1alpha2/operations",
+ "path": "v1alpha2/{+name}",
"id": "genomics.operations.list",
- "path": "v1alpha2/{+name}"
+ "description": "Lists operations that match the specified filter in the request."
}
}
}
},
"parameters": {
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
"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": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
@@ -302,17 +325,12 @@
"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\").",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
@@ -329,13 +347,12 @@
],
"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": [
@@ -343,33 +360,24 @@
"media",
"proto"
],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
"type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
+ "enumDescriptions": [
+ "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": {
"PipelineParameter": {
+ "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eGoogle Cloud storage path\u003c/th\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\u003ctd\u003eglob\u003c/td\u003e\u003ctd\u003edirectory\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003cth\u003eGoogle Cloud Storage path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003efile\u003c/td\u003e\n \u003ctd\u003edirectory - directory must already exist\u003c/td\u003e\n \u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003eglob\u003c/td\u003e\n \u003ctd\u003edirectory - directory will be created if it doesn't exist\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.",
+ "type": "object",
"properties": {
+ "defaultValue": {
+ "description": "The default value for this parameter. Can be overridden at runtime.\nIf `localCopy` is present, then this must be a Google Cloud Storage path\nbeginning with `gs://`.",
+ "type": "string"
+ },
"name": {
"description": "Required. Name of the parameter - the pipeline runner uses this string\nas the key to the input and output maps in RunPipeline.",
"type": "string"
@@ -379,17 +387,11 @@
"type": "string"
},
"localCopy": {
- "$ref": "LocalCopy",
- "description": "If present, this parameter is marked for copying to and from the VM.\n`LocalCopy` indicates where on the VM the file should be. The value\ngiven to this parameter (either at runtime or using `defaultValue`)\nmust be the remote path where the file should be."
- },
- "defaultValue": {
- "description": "The default value for this parameter. Can be overridden at runtime.\nIf `localCopy` is present, then this must be a Google Cloud Storage path\nbeginning with `gs://`.",
- "type": "string"
+ "description": "If present, this parameter is marked for copying to and from the VM.\n`LocalCopy` indicates where on the VM the file should be. The value\ngiven to this parameter (either at runtime or using `defaultValue`)\nmust be the remote path where the file should be.",
+ "$ref": "LocalCopy"
}
},
- "id": "PipelineParameter",
- "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"
+ "id": "PipelineParameter"
},
"LoggingOptions": {
"properties": {
@@ -403,23 +405,23 @@
"type": "object"
},
"RunPipelineRequest": {
- "description": "The request to run a pipeline. If `pipelineId` is specified, it\nrefers to a saved pipeline created with CreatePipeline and set as\nthe `pipelineId` of the returned Pipeline object. If\n`ephemeralPipeline` is specified, that pipeline is run once\nwith the given args and not saved. It is an error to specify both\n`pipelineId` and `ephemeralPipeline`. `pipelineArgs`\nmust be specified.",
- "type": "object",
"properties": {
+ "ephemeralPipeline": {
+ "$ref": "Pipeline",
+ "description": "A new pipeline object to run once and then delete."
+ },
"pipelineArgs": {
- "$ref": "RunPipelineArgs",
- "description": "The arguments to use when running this pipeline."
+ "description": "The arguments to use when running this pipeline.",
+ "$ref": "RunPipelineArgs"
},
"pipelineId": {
"description": "The already created pipeline to run.",
"type": "string"
- },
- "ephemeralPipeline": {
- "description": "A new pipeline object to run once and then delete.",
- "$ref": "Pipeline"
}
},
- "id": "RunPipelineRequest"
+ "id": "RunPipelineRequest",
+ "description": "The request to run a pipeline. If `pipelineId` is specified, it\nrefers to a saved pipeline created with CreatePipeline and set as\nthe `pipelineId` of the returned Pipeline object. If\n`ephemeralPipeline` is specified, that pipeline is run once\nwith the given args and not saved. It is an error to specify both\n`pipelineId` and `ephemeralPipeline`. `pipelineArgs`\nmust be specified.",
+ "type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
@@ -427,12 +429,21 @@
"properties": {},
"id": "CancelOperationRequest"
},
+ "RuntimeMetadata": {
+ "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.",
+ "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.",
+ "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": {
@@ -460,18 +471,9 @@
"type": "object"
}
},
- "id": "Operation"
- },
- "RuntimeMetadata": {
- "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
- "type": "object",
- "properties": {
- "computeEngine": {
- "description": "Execution information specific to Google Compute Engine.",
- "$ref": "ComputeEngine"
- }
- },
- "id": "RuntimeMetadata"
+ "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.",
@@ -488,7 +490,13 @@
"id": "ImportReadGroupSetsResponse"
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -504,17 +512,13 @@
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
+ "id": "Status"
},
"ServiceAccount": {
+ "description": "A Google Cloud Service Account.",
+ "type": "object",
"properties": {
"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",
@@ -528,29 +532,12 @@
"type": "string"
}
},
- "id": "ServiceAccount",
- "description": "A Google Cloud Service Account.",
- "type": "object"
+ "id": "ServiceAccount"
},
"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.",
- "items": {
- "$ref": "PipelineParameter"
- },
- "type": "array"
- },
- "docker": {
- "$ref": "DockerExecutor",
- "description": "Specifies the docker run information."
- },
- "description": {
- "description": "User-specified description.",
- "type": "string"
- },
"inputParameters": {
"description": "Input parameters of the pipeline.",
"items": {
@@ -566,30 +553,34 @@
"description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines.",
"type": "string"
},
+ "pipelineId": {
+ "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline.",
+ "type": "string"
+ },
"projectId": {
"description": "Required. The project in which to create the pipeline. The caller must have\nWRITE access.",
"type": "string"
},
- "pipelineId": {
- "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline.",
+ "outputParameters": {
+ "description": "Output parameters of the pipeline.",
+ "items": {
+ "$ref": "PipelineParameter"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "User-specified description.",
"type": "string"
+ },
+ "docker": {
+ "description": "Specifies the docker run information.",
+ "$ref": "DockerExecutor"
}
},
"id": "Pipeline"
},
"PipelineResources": {
- "description": "The system resources for the pipeline run.",
- "type": "object",
"properties": {
- "preemptible": {
- "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.",
- "type": "boolean"
- },
- "minimumRamGb": {
- "format": "double",
- "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
- "type": "number"
- },
"zones": {
"description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.",
"items": {
@@ -617,14 +608,31 @@
"format": "int32",
"description": "The size of the boot disk. Defaults to 10 (GB).",
"type": "integer"
+ },
+ "preemptible": {
+ "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.",
+ "type": "boolean"
+ },
+ "minimumRamGb": {
+ "format": "double",
+ "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
+ "type": "number"
}
},
- "id": "PipelineResources"
+ "id": "PipelineResources",
+ "description": "The system resources for the pipeline run.",
+ "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": {
+ "machineType": {
+ "type": "string"
+ },
+ "cmd": {
+ "type": "string"
+ },
"vars": {
"additionalProperties": {
"type": "string"
@@ -654,12 +662,6 @@
"type": "string"
},
"type": "object"
- },
- "machineType": {
- "type": "string"
- },
- "cmd": {
- "type": "string"
}
},
"id": "ControllerConfig"
@@ -686,6 +688,7 @@
"id": "OperationEvent"
},
"RepeatedString": {
+ "type": "object",
"properties": {
"values": {
"items": {
@@ -694,12 +697,9 @@
"type": "array"
}
},
- "id": "RepeatedString",
- "type": "object"
+ "id": "RepeatedString"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -713,36 +713,14 @@
"type": "array"
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"OperationMetadata": {
"description": "Metadata describing an Operation.",
"type": "object",
"properties": {
- "runtimeMetadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Runtime metadata on this Operation.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
- "type": "object"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "The time at which the job was submitted to the Genomics service.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Cloud Project in which the job is scoped.",
- "type": "string"
- },
"clientId": {
"description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
"type": "string"
@@ -771,10 +749,52 @@
},
"description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
"type": "object"
+ },
+ "runtimeMetadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Runtime metadata on this Operation.",
+ "type": "object"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
+ "type": "object"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Cloud Project in which the job is scoped.",
+ "type": "string"
}
},
"id": "OperationMetadata"
},
+ "ListPipelinesResponse": {
+ "description": "The response of ListPipelines. Contains at most `pageSize`\npipelines. If it contains `pageSize` pipelines, and more pipelines\nexist, then `nextPageToken` will be populated and should be\nused as the `pageToken` argument to a subsequent ListPipelines\nrequest.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The token to use to get the next page of results.",
+ "type": "string"
+ },
+ "pipelines": {
+ "description": "The matched pipelines.",
+ "items": {
+ "$ref": "Pipeline"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListPipelinesResponse"
+ },
"RunPipelineArgs": {
"description": "The pipeline run arguments.",
"type": "object",
@@ -828,48 +848,9 @@
},
"id": "RunPipelineArgs"
},
- "ListPipelinesResponse": {
- "description": "The response of ListPipelines. Contains at most `pageSize`\npipelines. If it contains `pageSize` pipelines, and more pipelines\nexist, then `nextPageToken` will be populated and should be\nused as the `pageToken` argument to a subsequent ListPipelines\nrequest.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The token to use to get the next page of results.",
- "type": "string"
- },
- "pipelines": {
- "description": "The matched pipelines.",
- "items": {
- "$ref": "Pipeline"
- },
- "type": "array"
- }
- },
- "id": "ListPipelinesResponse"
- },
"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": {
"errorCode": {
- "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",
- "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error",
- "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request",
- "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout",
- "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found",
- "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict",
- "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden",
- "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized",
- "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests",
- "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request",
- "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict",
- "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request",
- "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented",
- "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error",
- "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable",
- "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error"
- ],
"enum": [
"OK",
"CANCELLED",
@@ -889,7 +870,26 @@
"UNAVAILABLE",
"DATA_LOSS"
],
- "type": "string"
+ "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",
+ "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error",
+ "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request",
+ "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout",
+ "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found",
+ "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict",
+ "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden",
+ "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized",
+ "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests",
+ "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request",
+ "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict",
+ "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request",
+ "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented",
+ "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error",
+ "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable",
+ "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error"
+ ]
},
"timestampEvents": {
"items": {
@@ -908,28 +908,12 @@
"type": "string"
}
},
- "id": "SetOperationStatusRequest"
- },
- "ImportVariantsResponse": {
- "properties": {
- "callSetIds": {
- "description": "IDs of the call sets created during the import.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "ImportVariantsResponse",
- "description": "The variant data import response.",
+ "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"
},
"ComputeEngine": {
"properties": {
- "zone": {
- "description": "The availability zone in which the instance resides.",
- "type": "string"
- },
"diskNames": {
"description": "The names of the disks that were created for this pipeline.",
"items": {
@@ -944,12 +928,30 @@
"instanceName": {
"description": "The instance on which the operation is running.",
"type": "string"
+ },
+ "zone": {
+ "description": "The availability zone in which the instance resides.",
+ "type": "string"
}
},
"id": "ComputeEngine",
"description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
"type": "object"
},
+ "ImportVariantsResponse": {
+ "properties": {
+ "callSetIds": {
+ "description": "IDs of the call sets created during the import.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ImportVariantsResponse",
+ "description": "The variant data import response.",
+ "type": "object"
+ },
"TimestampEvent": {
"description": "Stores the list of events and times they occured for major events in job\nexecution.",
"type": "object",
@@ -982,6 +984,8 @@
"type": "object"
},
"DockerExecutor": {
+ "description": "The Docker execuctor specification.",
+ "type": "object",
"properties": {
"cmd": {
"description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384.",
@@ -992,34 +996,16 @@
"type": "string"
}
},
- "id": "DockerExecutor",
- "description": "The Docker execuctor specification.",
+ "id": "DockerExecutor"
+ },
+ "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"
},
"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": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "PERSISTENT_HDD",
- "PERSISTENT_SSD",
- "LOCAL_SSD"
- ],
- "description": "Required. The type of the disk to create.",
- "type": "string",
- "enumDescriptions": [
- "Default disk type. Use one of the other options below.",
- "Specifies a Google Compute Engine persistent hard disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
- "Specifies a Google Compute Engine persistent solid-state disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
- "Specifies a Google Compute Engine local SSD.\nSee https://cloud.google.com/compute/docs/disks/local-ssd for details."
- ]
- },
"autoDelete": {
"description": "Deprecated. Disks created by the Pipelines API will be deleted at the end\nof the pipeline run, regardless of what this field is set to.",
"type": "boolean"
@@ -1040,15 +1026,31 @@
"source": {
"description": "The full or partial URL of the persistent disk to attach. See\nhttps://cloud.google.com/compute/docs/reference/latest/instances#resource\nand\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#snapshots\nfor more details.",
"type": "string"
+ },
+ "name": {
+ "description": "Required. The name of the disk that can be used in the pipeline\nparameters. Must be 1 - 63 characters.\nThe name \"boot\" is reserved for system use.",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PERSISTENT_HDD",
+ "PERSISTENT_SSD",
+ "LOCAL_SSD"
+ ],
+ "description": "Required. The type of the disk to create.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default disk type. Use one of the other options below.",
+ "Specifies a Google Compute Engine persistent hard disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
+ "Specifies a Google Compute Engine persistent solid-state disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
+ "Specifies a Google Compute Engine local SSD.\nSee https://cloud.google.com/compute/docs/disks/local-ssd for details."
+ ]
}
},
- "id": "Disk"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "id": "Disk",
+ "description": "A Google Compute Engine disk resource specification.",
+ "type": "object"
}
},
"icons": {
@@ -1081,10 +1083,8 @@
"ownerDomain": "google.com",
"name": "genomics",
"batchPath": "batch",
- "id": "genomics:v1alpha2",
+ "revision": "20170824",
"documentationLink": "https://cloud.google.com/genomics",
- "revision": "20170819",
- "title": "Genomics API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "id": "genomics:v1alpha2",
+ "title": "Genomics API"
}
diff --git a/genomics/v1alpha2/genomics-gen.go b/genomics/v1alpha2/genomics-gen.go
index 456d103..ead7beb 100644
--- a/genomics/v1alpha2/genomics-gen.go
+++ b/genomics/v1alpha2/genomics-gen.go
@@ -561,8 +561,8 @@
type Operation struct {
// Done: If the value is `false`, it means the operation is still in
// progress.
- // If true, the operation is completed, and either `error` or `response`
- // is
+ // If `true`, the operation is completed, and either `error` or
+ // `response` is
// available.
Done bool `json:"done,omitempty"`
diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json
index b43106f..03555e5 100644
--- a/iam/v1/iam-api.json
+++ b/iam/v1/iam-api.json
@@ -1,341 +1,14 @@
{
+ "basePath": "",
+ "id": "iam:v1",
+ "documentationLink": "https://cloud.google.com/iam/",
+ "revision": "20170824",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CreateRoleRequest": {
- "description": "The request to create a new role.",
- "type": "object",
- "properties": {
- "roleId": {
- "description": "The role id to use for this role.",
- "type": "string"
- },
- "role": {
- "description": "The Role resource to create.",
- "$ref": "Role"
- }
- },
- "id": "CreateRoleRequest"
- },
- "QueryTestablePermissionsRequest": {
- "description": "A request to get permissions which can be tested on a resource.",
- "type": "object",
- "properties": {
- "fullResourceName": {
- "description": "Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
- "type": "string"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional limit on the number of permissions to include in the response.",
- "type": "integer"
- }
- },
- "id": "QueryTestablePermissionsRequest"
- },
- "TestIamPermissionsResponse": {
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
- },
- "ListServiceAccountKeysResponse": {
- "description": "The service account keys list response.",
- "type": "object",
- "properties": {
- "keys": {
- "description": "The public keys for the service account.",
- "items": {
- "$ref": "ServiceAccountKey"
- },
- "type": "array"
- }
- },
- "id": "ListServiceAccountKeysResponse"
- },
- "ServiceAccountKey": {
- "description": "Represents a service account key.\n\nA service account has two sets of key-pairs: user-managed, and\nsystem-managed.\n\nUser-managed key-pairs can be created and deleted by users. Users are\nresponsible for rotating these keys periodically to ensure security of\ntheir service accounts. Users retain the private key of these key-pairs,\nand Google retains ONLY the public key.\n\nSystem-managed key-pairs are managed automatically by Google, and rotated\ndaily without user intervention. The private key never leaves Google's\nservers to maximize security.\n\nPublic keys for all service accounts are also published at the OAuth2\nService Account API.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.",
- "type": "string"
- },
- "validBeforeTime": {
- "format": "google-datetime",
- "description": "The key can be used before this timestamp.",
- "type": "string"
- },
- "keyAlgorithm": {
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key."
- ],
- "enum": [
- "KEY_ALG_UNSPECIFIED",
- "KEY_ALG_RSA_1024",
- "KEY_ALG_RSA_2048"
- ],
- "description": "Specifies the algorithm (and possibly key size) for the key.",
- "type": "string"
- },
- "validAfterTime": {
- "format": "google-datetime",
- "description": "The key can be used after this timestamp.",
- "type": "string"
- },
- "privateKeyType": {
- "enumDescriptions": [
- "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
- "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
- "Google Credentials File format."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_PKCS12_FILE",
- "TYPE_GOOGLE_CREDENTIALS_FILE"
- ],
- "description": "The output format for the private key.\nOnly provided in `CreateServiceAccountKey` responses, not\nin `GetServiceAccountKey` or `ListServiceAccountKey` responses.\n\nGoogle never exposes system-managed private keys, and never retains\nuser-managed private keys.",
- "type": "string"
- },
- "privateKeyData": {
- "format": "byte",
- "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses. Make sure to keep the private key data secure because it\nallows for the assertion of the service account identity.\nWhen decoded, the private key data can be used to authenticate with\nGoogle API client libraries and with\n\u003ca href=\"/sdk/gcloud/reference/auth/activate-service-account\"\u003egcloud\nauth activate-service-account\u003c/a\u003e.",
- "type": "string"
- },
- "publicKeyData": {
- "format": "byte",
- "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
- "type": "string"
- }
- },
- "id": "ServiceAccountKey"
- },
- "SignBlobResponse": {
- "description": "The service account sign blob response.",
- "type": "object",
- "properties": {
- "signature": {
- "format": "byte",
- "description": "The signed blob.",
- "type": "string"
- },
- "keyId": {
- "description": "The id of the key used to sign the blob.",
- "type": "string"
- }
- },
- "id": "SignBlobResponse"
- },
- "SignJwtRequest": {
- "description": "The service account sign JWT request.",
- "type": "object",
- "properties": {
- "payload": {
- "description": "The JWT payload to sign, a JSON JWT Claim set.",
- "type": "string"
- }
- },
- "id": "SignJwtRequest"
- },
- "Permission": {
- "description": "A permission which can be included by a role.",
- "type": "object",
- "properties": {
- "stage": {
- "enum": [
- "ALPHA",
- "BETA",
- "GA",
- "DEPRECATED"
- ],
- "description": "The current launch stage of the permission.",
- "type": "string",
- "enumDescriptions": [
- "The permission is currently in an alpha phase.",
- "The permission is currently in a beta phase.",
- "The permission is generally available.",
- "The permission is being deprecated."
- ]
- },
- "name": {
- "description": "The name of this Permission.",
- "type": "string"
- },
- "onlyInPredefinedRoles": {
- "description": "This permission can ONLY be used in predefined roles.",
- "type": "boolean"
- },
- "title": {
- "description": "The title of this Permission.",
- "type": "string"
- },
- "description": {
- "description": "A brief description of what this Permission is used for.",
- "type": "string"
- },
- "customRolesSupportLevel": {
- "enum": [
- "SUPPORTED",
- "TESTING",
- "NOT_SUPPORTED"
- ],
- "description": "The current custom role support level.",
- "type": "string",
- "enumDescriptions": [
- "Permission is fully supported for custom role use.",
- "Permission is being tested to check custom role compatibility.",
- "Permission is not supported for custom role use."
- ]
- }
- },
- "id": "Permission"
- },
- "PolicyDelta": {
- "description": "The difference delta between two policies.",
- "type": "object",
- "properties": {
- "bindingDeltas": {
- "description": "The delta for Bindings between two policies.",
- "items": {
- "$ref": "BindingDelta"
- },
- "type": "array"
- }
- },
- "id": "PolicyDelta"
- },
- "ListServiceAccountsResponse": {
- "description": "The service account list response.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "To retrieve the next page of results, set\nListServiceAccountsRequest.page_token\nto this value.",
- "type": "string"
- },
- "accounts": {
- "description": "The list of matching service accounts.",
- "items": {
- "$ref": "ServiceAccount"
- },
- "type": "array"
- }
- },
- "id": "ListServiceAccountsResponse"
- },
- "QueryGrantableRolesResponse": {
- "description": "The grantable role query response.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "To retrieve the next page of results, set\n`QueryGrantableRolesRequest.page_token` to this value.",
- "type": "string"
- },
- "roles": {
- "description": "The list of matching roles.",
- "items": {
- "$ref": "Role"
- },
- "type": "array"
- }
- },
- "id": "QueryGrantableRolesResponse"
- },
- "SignBlobRequest": {
- "description": "The service account sign blob request.",
- "type": "object",
- "properties": {
- "bytesToSign": {
- "format": "byte",
- "description": "The bytes to sign.",
- "type": "string"
- }
- },
- "id": "SignBlobRequest"
- },
- "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"
- },
- "QueryTestablePermissionsResponse": {
- "description": "The response containing permissions which can be tested on a resource.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "To retrieve the next page of results, set\n`QueryTestableRolesRequest.page_token` to this value.",
- "type": "string"
- },
- "permissions": {
- "description": "The Permissions testable on the requested resource.",
- "items": {
- "$ref": "Permission"
- },
- "type": "array"
- }
- },
- "id": "QueryTestablePermissionsResponse"
- },
- "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"
- },
- "CreateServiceAccountKeyRequest": {
- "description": "The service account key create request.",
- "type": "object",
- "properties": {
- "keyAlgorithm": {
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key."
- ],
- "enum": [
- "KEY_ALG_UNSPECIFIED",
- "KEY_ALG_RSA_1024",
- "KEY_ALG_RSA_2048"
- ],
- "description": "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": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_PKCS12_FILE",
- "TYPE_GOOGLE_CREDENTIALS_FILE"
- ],
- "description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
- "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
- "Google Credentials File format."
- ]
- }
- },
- "id": "CreateServiceAccountKeyRequest"
- },
"SignJwtResponse": {
+ "description": "The service account sign JWT response.",
+ "type": "object",
"properties": {
"signedJwt": {
"description": "The signed JWT.",
@@ -346,9 +19,7 @@
"type": "string"
}
},
- "id": "SignJwtResponse",
- "description": "The service account sign JWT response.",
- "type": "object"
+ "id": "SignJwtResponse"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
@@ -365,6 +36,8 @@
"id": "TestIamPermissionsRequest"
},
"Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
"properties": {
"etag": {
"format": "byte",
@@ -384,11 +57,10 @@
"type": "array"
}
},
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object"
+ "id": "Policy"
},
"ListRolesResponse": {
+ "id": "ListRolesResponse",
"description": "The response containing the roles defined under a resource.",
"type": "object",
"properties": {
@@ -403,32 +75,24 @@
},
"type": "array"
}
- },
- "id": "ListRolesResponse"
+ }
},
"AuditData": {
"description": "Audit log information specific to Cloud IAM. This message is serialized\nas an `Any` type in the `ServiceData` message of an\n`AuditLog` message.",
"type": "object",
"properties": {
"policyDelta": {
- "description": "Policy delta between the original policy and the newly set policy.",
- "$ref": "PolicyDelta"
+ "$ref": "PolicyDelta",
+ "description": "Policy delta between the original policy and the newly set policy."
}
},
"id": "AuditData"
},
"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",
"properties": {
- "condition": {
- "$ref": "Expr",
- "description": "The condition that is associated with this binding.\nThis field is GOOGLE_INTERNAL.\nThis field is not logged in IAM side because it's only for audit logging.\nOptional"
- },
- "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"
@@ -446,11 +110,19 @@
"ADD",
"REMOVE"
]
+ },
+ "condition": {
+ "$ref": "Expr",
+ "description": "The condition that is associated with this binding.\nThis field is GOOGLE_INTERNAL.\nThis field is not logged in IAM side because it's only for audit logging.\nOptional"
+ },
+ "member": {
+ "description": "A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
+ "type": "string"
}
- },
- "id": "BindingDelta"
+ }
},
"UndeleteRoleRequest": {
+ "id": "UndeleteRoleRequest",
"description": "The request to undelete an existing role.",
"type": "object",
"properties": {
@@ -459,10 +131,10 @@
"description": "Used to perform a consistent read-modify-write.",
"type": "string"
}
- },
- "id": "UndeleteRoleRequest"
+ }
},
"CreateServiceAccountRequest": {
+ "id": "CreateServiceAccountRequest",
"description": "The service account create request.",
"type": "object",
"properties": {
@@ -471,26 +143,15 @@
"type": "string"
},
"serviceAccount": {
- "$ref": "ServiceAccount",
- "description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` ."
+ "description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` .",
+ "$ref": "ServiceAccount"
}
- },
- "id": "CreateServiceAccountRequest"
+ }
},
"Role": {
+ "description": "A role in the Identity and Access Management API.",
+ "type": "object",
"properties": {
- "name": {
- "description": "The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.",
- "type": "string"
- },
- "deleted": {
- "description": "The current deleted state of the role. This field is read only.\nIt will be ignored in calls to CreateRole and UpdateRole.",
- "type": "boolean"
- },
- "title": {
- "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
- "type": "string"
- },
"includedPermissions": {
"description": "The names of the permissions this role grants when bound in an IAM policy.",
"items": {
@@ -508,6 +169,8 @@
"type": "string"
},
"stage": {
+ "description": "The current launch stage of the role.",
+ "type": "string",
"enumDescriptions": [
"The user has indicated this role is currently in an alpha phase.",
"The user has indicated this role is currently in a beta phase.",
@@ -523,16 +186,26 @@
"DEPRECATED",
"DISABLED",
"EAP"
- ],
- "description": "The current launch stage of the role.",
+ ]
+ },
+ "name": {
+ "description": "The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.",
+ "type": "string"
+ },
+ "deleted": {
+ "description": "The current deleted state of the role. This field is read only.\nIt will be ignored in calls to CreateRole and UpdateRole.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
"type": "string"
}
},
- "id": "Role",
- "description": "A role in the Identity and Access Management API.",
- "type": "object"
+ "id": "Role"
},
"Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
"properties": {
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
@@ -546,22 +219,13 @@
"type": "string"
}
},
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
+ "id": "Binding"
},
"Expr": {
+ "id": "Expr",
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"type": "object",
"properties": {
- "location": {
- "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
- "type": "string"
- },
- "title": {
- "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
- "type": "string"
- },
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
@@ -569,22 +233,61 @@
"expression": {
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type": "string"
+ },
+ "location": {
+ "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
+ "type": "string"
+ },
+ "title": {
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
+ "type": "string"
+ }
+ }
+ },
+ "QueryGrantableRolesRequest": {
+ "description": "The grantable role query request.",
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional limit on the number of roles to include in the response.",
+ "type": "integer"
+ },
+ "view": {
+ "type": "string",
+ "enumDescriptions": [
+ "Omits the `included_permissions` field.\nThis is the default value.",
+ "Returns all fields."
+ ],
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ },
+ "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": "Expr"
+ "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": {
- "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"
},
+ "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"
@@ -606,39 +309,341 @@
"description": "@OutputOnly The id of the project that owns the service account.",
"type": "string"
}
- },
- "id": "ServiceAccount"
+ }
},
- "QueryGrantableRolesRequest": {
- "description": "The grantable role query request.",
+ "CreateRoleRequest": {
+ "id": "CreateRoleRequest",
+ "description": "The request to create a new role.",
"type": "object",
"properties": {
- "pageSize": {
- "format": "int32",
- "description": "Optional limit on the number of roles to include in the response.",
- "type": "integer"
- },
- "view": {
- "type": "string",
- "enumDescriptions": [
- "Omits the `included_permissions` field.\nThis is the default value.",
- "Returns all fields."
- ],
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "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`.",
+ "roleId": {
+ "description": "The role id to use for this role.",
"type": "string"
},
+ "role": {
+ "description": "The Role resource to create.",
+ "$ref": "Role"
+ }
+ }
+ },
+ "QueryTestablePermissionsRequest": {
+ "description": "A request to get permissions which can be tested on a resource.",
+ "type": "object",
+ "properties": {
"pageToken": {
- "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
+ "description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional limit on the number of permissions to include in the response.",
+ "type": "integer"
+ },
+ "fullResourceName": {
+ "description": "Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
"type": "string"
}
},
- "id": "QueryGrantableRolesRequest"
+ "id": "QueryTestablePermissionsRequest"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "ListServiceAccountKeysResponse": {
+ "id": "ListServiceAccountKeysResponse",
+ "description": "The service account keys list response.",
+ "type": "object",
+ "properties": {
+ "keys": {
+ "description": "The public keys for the service account.",
+ "items": {
+ "$ref": "ServiceAccountKey"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "ServiceAccountKey": {
+ "description": "Represents a service account key.\n\nA service account has two sets of key-pairs: user-managed, and\nsystem-managed.\n\nUser-managed key-pairs can be created and deleted by users. Users are\nresponsible for rotating these keys periodically to ensure security of\ntheir service accounts. Users retain the private key of these key-pairs,\nand Google retains ONLY the public key.\n\nSystem-managed key-pairs are managed automatically by Google, and rotated\ndaily without user intervention. The private key never leaves Google's\nservers to maximize security.\n\nPublic keys for all service accounts are also published at the OAuth2\nService Account API.",
+ "type": "object",
+ "properties": {
+ "privateKeyData": {
+ "format": "byte",
+ "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses. Make sure to keep the private key data secure because it\nallows for the assertion of the service account identity.\nWhen decoded, the private key data can be used to authenticate with\nGoogle API client libraries and with\n\u003ca href=\"/sdk/gcloud/reference/auth/activate-service-account\"\u003egcloud\nauth activate-service-account\u003c/a\u003e.",
+ "type": "string"
+ },
+ "publicKeyData": {
+ "format": "byte",
+ "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.",
+ "type": "string"
+ },
+ "validBeforeTime": {
+ "format": "google-datetime",
+ "description": "The key can be used before this timestamp.",
+ "type": "string"
+ },
+ "keyAlgorithm": {
+ "description": "Specifies the algorithm (and possibly key size) for the key.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified key algorithm.",
+ "1k RSA Key.",
+ "2k RSA Key."
+ ],
+ "enum": [
+ "KEY_ALG_UNSPECIFIED",
+ "KEY_ALG_RSA_1024",
+ "KEY_ALG_RSA_2048"
+ ]
+ },
+ "validAfterTime": {
+ "format": "google-datetime",
+ "description": "The key can be used after this timestamp.",
+ "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"
+ ]
+ }
+ },
+ "id": "ServiceAccountKey"
+ },
+ "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": {
+ "format": "byte",
+ "description": "The signed blob.",
+ "type": "string"
+ }
+ },
+ "id": "SignBlobResponse"
+ },
+ "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"
+ }
+ }
+ },
+ "Permission": {
+ "id": "Permission",
+ "description": "A permission which can be included by a role.",
+ "type": "object",
+ "properties": {
+ "onlyInPredefinedRoles": {
+ "description": "This permission can ONLY be used in predefined roles.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "The title of this Permission.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A brief description of what this Permission is used for.",
+ "type": "string"
+ },
+ "customRolesSupportLevel": {
+ "description": "The current custom role support level.",
+ "type": "string",
+ "enumDescriptions": [
+ "Permission is fully supported for custom role use.",
+ "Permission is being tested to check custom role compatibility.",
+ "Permission is not supported for custom role use."
+ ],
+ "enum": [
+ "SUPPORTED",
+ "TESTING",
+ "NOT_SUPPORTED"
+ ]
+ },
+ "stage": {
+ "enumDescriptions": [
+ "The permission is currently in an alpha phase.",
+ "The permission is currently in a beta phase.",
+ "The permission is generally available.",
+ "The permission is being deprecated."
+ ],
+ "enum": [
+ "ALPHA",
+ "BETA",
+ "GA",
+ "DEPRECATED"
+ ],
+ "description": "The current launch stage of the permission.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of this Permission.",
+ "type": "string"
+ }
+ }
+ },
+ "PolicyDelta": {
+ "id": "PolicyDelta",
+ "description": "The difference delta between two policies.",
+ "type": "object",
+ "properties": {
+ "bindingDeltas": {
+ "description": "The delta for Bindings between two policies.",
+ "items": {
+ "$ref": "BindingDelta"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "ListServiceAccountsResponse": {
+ "id": "ListServiceAccountsResponse",
+ "description": "The service account list response.",
+ "type": "object",
+ "properties": {
+ "accounts": {
+ "description": "The list of matching service accounts.",
+ "items": {
+ "$ref": "ServiceAccount"
+ },
+ "type": "array"
+ },
+ "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",
+ "properties": {
+ "nextPageToken": {
+ "description": "To retrieve the next page of results, set\n`QueryGrantableRolesRequest.page_token` to this value.",
+ "type": "string"
+ },
+ "roles": {
+ "description": "The list of matching roles.",
+ "items": {
+ "$ref": "Role"
+ },
+ "type": "array"
+ }
+ },
+ "id": "QueryGrantableRolesResponse"
+ },
+ "SignBlobRequest": {
+ "id": "SignBlobRequest",
+ "description": "The service account sign blob request.",
+ "type": "object",
+ "properties": {
+ "bytesToSign": {
+ "format": "byte",
+ "description": "The bytes to sign.",
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ },
+ "QueryTestablePermissionsResponse": {
+ "id": "QueryTestablePermissionsResponse",
+ "description": "The response containing permissions which can be tested on a resource.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "To retrieve the next page of results, set\n`QueryTestableRolesRequest.page_token` to this value.",
+ "type": "string"
+ },
+ "permissions": {
+ "description": "The Permissions testable on the requested resource.",
+ "items": {
+ "$ref": "Permission"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "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": {}
+ },
+ "CreateServiceAccountKeyRequest": {
+ "id": "CreateServiceAccountKeyRequest",
+ "description": "The service account key create request.",
+ "type": "object",
+ "properties": {
+ "keyAlgorithm": {
+ "enumDescriptions": [
+ "An unspecified key algorithm.",
+ "1k RSA Key.",
+ "2k RSA Key."
+ ],
+ "enum": [
+ "KEY_ALG_UNSPECIFIED",
+ "KEY_ALG_RSA_1024",
+ "KEY_ALG_RSA_2048"
+ ],
+ "description": "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": {
+ "enumDescriptions": [
+ "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
+ "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
+ "Google Credentials File format."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_PKCS12_FILE",
+ "TYPE_GOOGLE_CREDENTIALS_FILE"
+ ],
+ "description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.",
+ "type": "string"
+ }
+ }
}
},
"icons": {
@@ -664,218 +669,11 @@
"title": "Google Identity and Access Management (IAM) API",
"ownerName": "Google",
"resources": {
- "organizations": {
- "resources": {
- "roles": {
- "methods": {
- "delete": {
- "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "etag": {
- "format": "byte",
- "description": "Used to perform a consistent read-modify-write.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
- "id": "iam.organizations.roles.delete",
- "path": "v1/{+name}"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListRolesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "showDeleted": {
- "location": "query",
- "description": "Include Roles that have been deleted.",
- "type": "boolean"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token returned in an earlier ListRolesResponse.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional limit on the number of roles to include in the response.",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Optional view for the returned Role objects.",
- "type": "string"
- },
- "parent": {
- "location": "path",
- "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}/roles",
- "path": "v1/{+parent}/roles",
- "id": "iam.organizations.roles.list",
- "description": "Lists the Roles defined on a resource."
- },
- "create": {
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles",
- "id": "iam.organizations.roles.create",
- "path": "v1/{+parent}/roles",
- "description": "Creates a new Role.",
- "request": {
- "$ref": "CreateRoleRequest"
- }
- },
- "undelete": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- },
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete",
- "path": "v1/{+name}:undelete",
- "id": "iam.organizations.roles.undelete",
- "description": "Undelete a Role, bringing it back in its previous state.",
- "request": {
- "$ref": "UndeleteRoleRequest"
- }
- },
- "get": {
- "description": "Gets a Role definition.",
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
- "id": "iam.organizations.roles.get",
- "path": "v1/{+name}"
- },
- "patch": {
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
- "id": "iam.organizations.roles.patch",
- "path": "v1/{+name}",
- "description": "Updates a Role definition.",
- "request": {
- "$ref": "Role"
- },
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "A mask describing which fields in the Role have changed.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- },
"projects": {
"resources": {
"roles": {
"methods": {
"delete": {
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
- "id": "iam.projects.roles.delete",
- "path": "v1/{+name}",
"description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
"response": {
"$ref": "Role"
@@ -888,30 +686,25 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "etag": {
- "format": "byte",
- "description": "Used to perform a consistent read-modify-write.",
- "type": "string",
- "location": "query"
- },
"name": {
"description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/roles/[^/]+$",
"location": "path"
+ },
+ "etag": {
+ "location": "query",
+ "format": "byte",
+ "description": "Used to perform a consistent read-modify-write.",
+ "type": "string"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
+ "id": "iam.projects.roles.delete",
+ "path": "v1/{+name}"
},
"list": {
- "description": "Lists the Roles defined on a resource.",
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "ListRolesResponse"
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -922,19 +715,19 @@
"type": "string"
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "Optional limit on the number of roles to include in the response.",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"view": {
+ "location": "query",
"enum": [
"BASIC",
"FULL"
],
"description": "Optional view for the returned Role objects.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"parent": {
"pattern": "^projects/[^/]+$",
@@ -950,50 +743,36 @@
}
},
"flatPath": "v1/projects/{projectsId}/roles",
+ "path": "v1/{+parent}/roles",
"id": "iam.projects.roles.list",
- "path": "v1/{+parent}/roles"
- },
- "create": {
- "response": {
- "$ref": "Role"
- },
+ "description": "Lists the Roles defined on a resource.",
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/roles",
- "id": "iam.projects.roles.create",
+ "response": {
+ "$ref": "ListRolesResponse"
+ }
+ },
+ "create": {
"path": "v1/{+parent}/roles",
+ "id": "iam.projects.roles.create",
+ "description": "Creates a new Role.",
"request": {
"$ref": "CreateRoleRequest"
},
- "description": "Creates a new Role."
- },
- "get": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
"response": {
"$ref": "Role"
},
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
"parameters": {
- "name": {
- "pattern": "^projects/[^/]+/roles/[^/]+$",
+ "parent": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
"type": "string",
"required": true
}
@@ -1001,12 +780,27 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
- "id": "iam.projects.roles.get",
- "path": "v1/{+name}",
- "description": "Gets a Role definition."
+ "flatPath": "v1/projects/{projectsId}/roles"
},
"patch": {
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "A mask describing which fields in the Role have changed.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
"id": "iam.projects.roles.patch",
"path": "v1/{+name}",
@@ -1020,28 +814,39 @@
"parameterOrder": [
"name"
],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "A mask describing which fields in the Role have changed.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "httpMethod": "PATCH"
},
"undelete": {
+ "request": {
+ "$ref": "UndeleteRoleRequest"
+ },
+ "description": "Undelete a Role, bringing it back in its previous state.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete",
+ "id": "iam.projects.roles.undelete",
+ "path": "v1/{+name}:undelete"
+ },
+ "get": {
+ "description": "Gets a Role definition.",
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
@@ -1053,156 +858,25 @@
],
"parameters": {
"name": {
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
"pattern": "^projects/[^/]+/roles/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true
}
},
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete",
- "path": "v1/{+name}:undelete",
- "id": "iam.projects.roles.undelete",
- "request": {
- "$ref": "UndeleteRoleRequest"
- },
- "description": "Undelete a Role, bringing it back in its previous state."
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.roles.get"
}
}
},
"serviceAccounts": {
- "resources": {
- "keys": {
- "methods": {
- "create": {
- "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.",
- "type": "string",
- "required": true,
- "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",
- "description": "Creates a ServiceAccountKey\nand returns it.",
- "request": {
- "$ref": "CreateServiceAccountKeyRequest"
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.keys.delete",
- "description": "Deletes a ServiceAccountKey."
- },
- "get": {
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.keys.get",
- "description": "Gets the ServiceAccountKey\nby key id.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "parameters": {
- "publicKeyType": {
- "location": "query",
- "enum": [
- "TYPE_NONE",
- "TYPE_X509_PEM_FILE",
- "TYPE_RAW_PUBLIC_KEY"
- ],
- "description": "The output format of the public key requested.\nX509_PEM is the default output format.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.\n\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}"
- },
- "list": {
- "description": "Lists ServiceAccountKeys.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListServiceAccountKeysResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "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.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
- },
- "keyTypes": {
- "enum": [
- "KEY_TYPE_UNSPECIFIED",
- "USER_MANAGED",
- "SYSTEM_MANAGED"
- ],
- "description": "Filters the types of keys the user wants to include in the list\nresponse. Duplicate key types are not allowed. If no key type\nis provided, all keys are returned.",
- "type": "string",
- "repeated": true,
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
- "path": "v1/{+name}/keys",
- "id": "iam.projects.serviceAccounts.keys.list"
- }
- }
- }
- },
"methods": {
"getIamPolicy": {
+ "id": "iam.projects.serviceAccounts.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Returns the IAM access control policy for a\nServiceAccount.",
"response": {
"$ref": "Policy"
},
@@ -1212,35 +886,26 @@
"httpMethod": "POST",
"parameters": {
"resource": {
- "location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
- "id": "iam.projects.serviceAccounts.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "description": "Returns the IAM access control policy for a\nServiceAccount."
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy"
},
"get": {
- "id": "iam.projects.serviceAccounts.get",
- "path": "v1/{+name}",
- "description": "Gets a ServiceAccount.",
+ "httpMethod": "GET",
"response": {
"$ref": "ServiceAccount"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
@@ -1250,16 +915,22 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.get",
+ "description": "Gets a ServiceAccount."
},
"update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "ServiceAccount"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -1273,8 +944,8 @@
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
- "path": "v1/{+name}",
"id": "iam.projects.serviceAccounts.update",
+ "path": "v1/{+name}",
"request": {
"$ref": "ServiceAccount"
},
@@ -1283,10 +954,10 @@
"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"
},
+ "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -1294,28 +965,21 @@
"response": {
"$ref": "TestIamPermissionsResponse"
},
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions"
},
"delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
@@ -1331,48 +995,26 @@
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
"id": "iam.projects.serviceAccounts.delete",
"path": "v1/{+name}",
- "description": "Deletes a ServiceAccount."
- },
- "signBlob": {
- "request": {
- "$ref": "SignBlobRequest"
- },
- "description": "Signs a blob using a service account's system-managed private key.",
+ "description": "Deletes a ServiceAccount.",
"response": {
- "$ref": "SignBlobResponse"
+ "$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path",
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
- "id": "iam.projects.serviceAccounts.signBlob",
- "path": "v1/{+name}:signBlob"
+ "httpMethod": "DELETE"
},
"list": {
+ "path": "v1/{+name}/serviceAccounts",
+ "id": "iam.projects.serviceAccounts.list",
"description": "Lists ServiceAccounts for a project.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListServiceAccountsResponse"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"pageToken": {
"location": "query",
@@ -1380,11 +1022,11 @@
"type": "string"
},
"name": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
+ "required": true
},
"pageSize": {
"format": "int32",
@@ -1393,53 +1035,23 @@
"location": "query"
}
},
- "flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.list",
- "path": "v1/{+name}/serviceAccounts"
- },
- "setIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy",
- "id": "iam.projects.serviceAccounts.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the IAM access control policy for a\nServiceAccount.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts"
},
- "signJwt": {
+ "signBlob": {
+ "description": "Signs a blob using a service account's system-managed private key.",
"request": {
- "$ref": "SignJwtRequest"
+ "$ref": "SignBlobRequest"
},
- "description": "Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail.",
- "response": {
- "$ref": "SignJwtResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "SignBlobResponse"
+ },
"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.",
@@ -1449,22 +1061,49 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt",
- "id": "iam.projects.serviceAccounts.signJwt",
- "path": "v1/{+name}:signJwt"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
+ "path": "v1/{+name}:signBlob",
+ "id": "iam.projects.serviceAccounts.signBlob"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy",
+ "id": "iam.projects.serviceAccounts.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the IAM access control policy for a\nServiceAccount."
},
"create": {
- "description": "Creates a ServiceAccount\nand returns it.",
- "request": {
- "$ref": "CreateServiceAccountRequest"
- },
- "response": {
- "$ref": "ServiceAccount"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "ServiceAccount"
+ },
"parameters": {
"name": {
"description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
@@ -1478,8 +1117,170 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts",
+ "path": "v1/{+name}/serviceAccounts",
"id": "iam.projects.serviceAccounts.create",
- "path": "v1/{+name}/serviceAccounts"
+ "description": "Creates a ServiceAccount\nand returns it.",
+ "request": {
+ "$ref": "CreateServiceAccountRequest"
+ }
+ },
+ "signJwt": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SignJwtResponse"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt",
+ "path": "v1/{+name}:signJwt",
+ "id": "iam.projects.serviceAccounts.signJwt",
+ "description": "Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail.",
+ "request": {
+ "$ref": "SignJwtRequest"
+ }
+ }
+ },
+ "resources": {
+ "keys": {
+ "methods": {
+ "delete": {
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.keys.delete",
+ "description": "Deletes a ServiceAccountKey.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}"
+ },
+ "get": {
+ "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}`.\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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
+ "location": "path"
+ },
+ "publicKeyType": {
+ "location": "query",
+ "enum": [
+ "TYPE_NONE",
+ "TYPE_X509_PEM_FILE",
+ "TYPE_RAW_PUBLIC_KEY"
+ ],
+ "description": "The output format of the public key requested.\nX509_PEM is the default output format.",
+ "type": "string"
+ }
+ },
+ "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.",
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListServiceAccountKeysResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\n\nUsing `-` as a wildcard for the project, will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
+ },
+ "keyTypes": {
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "KEY_TYPE_UNSPECIFIED",
+ "USER_MANAGED",
+ "SYSTEM_MANAGED"
+ ],
+ "description": "Filters the types of keys the user wants to include in the list\nresponse. Duplicate key types are not allowed. If no key type\nis provided, all keys are returned.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
+ "id": "iam.projects.serviceAccounts.keys.list",
+ "path": "v1/{+name}/keys",
+ "description": "Lists ServiceAccountKeys."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
+ "path": "v1/{+name}/keys",
+ "id": "iam.projects.serviceAccounts.keys.create",
+ "request": {
+ "$ref": "CreateServiceAccountKeyRequest"
+ },
+ "description": "Creates a ServiceAccountKey\nand returns it."
+ }
+ }
}
}
}
@@ -1488,81 +1289,72 @@
"permissions": {
"methods": {
"queryTestablePermissions": {
- "flatPath": "v1/permissions:queryTestablePermissions",
- "path": "v1/permissions:queryTestablePermissions",
- "id": "iam.permissions.queryTestablePermissions",
- "request": {
- "$ref": "QueryTestablePermissionsRequest"
- },
- "description": "Lists the permissions testable on a resource.\nA permission is testable if it can be tested for an identity on a resource.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "QueryTestablePermissionsResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {}
+ "parameters": {},
+ "flatPath": "v1/permissions:queryTestablePermissions",
+ "id": "iam.permissions.queryTestablePermissions",
+ "path": "v1/permissions:queryTestablePermissions",
+ "request": {
+ "$ref": "QueryTestablePermissionsRequest"
+ },
+ "description": "Lists the permissions testable on a resource.\nA permission is testable if it can be tested for an identity on a resource."
}
}
},
"roles": {
"methods": {
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Role"
+ "queryGrantableRoles": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/roles:queryGrantableRoles",
+ "path": "v1/roles:queryGrantableRoles",
+ "id": "iam.roles.queryGrantableRoles",
+ "request": {
+ "$ref": "QueryGrantableRolesRequest"
},
+ "description": "Queries roles that can be granted on a particular resource.\nA role is grantable if it can be used as the role in a binding for a policy\nfor that resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "QueryGrantableRolesResponse"
+ }
+ },
+ "get": {
+ "description": "Gets a Role definition.",
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
+ "response": {
+ "$ref": "Role"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
+ "pattern": "^roles/[^/]+$",
+ "location": "path",
"description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"type": "string",
- "required": true,
- "pattern": "^roles/[^/]+$",
- "location": "path"
+ "required": true
}
},
"flatPath": "v1/roles/{rolesId}",
"path": "v1/{+name}",
- "id": "iam.roles.get",
- "description": "Gets a Role definition."
+ "id": "iam.roles.get"
},
"list": {
- "flatPath": "v1/roles",
- "id": "iam.roles.list",
- "path": "v1/roles",
- "description": "Lists the Roles defined on a resource.",
- "response": {
- "$ref": "ListRolesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Optional limit on the number of roles to include in the response.",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Optional view for the returned Role objects.",
- "type": "string"
- },
"parent": {
"location": "query",
"description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
@@ -1577,57 +1369,280 @@
"location": "query",
"description": "Optional pagination token returned in an earlier ListRolesResponse.",
"type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional limit on the number of roles to include in the response.",
+ "type": "integer"
+ },
+ "view": {
+ "description": "Optional view for the returned Role objects.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
}
- }
- },
- "queryGrantableRoles": {
- "response": {
- "$ref": "QueryGrantableRolesResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
- "flatPath": "v1/roles:queryGrantableRoles",
- "id": "iam.roles.queryGrantableRoles",
- "path": "v1/roles:queryGrantableRoles",
- "request": {
- "$ref": "QueryGrantableRolesRequest"
+ "flatPath": "v1/roles",
+ "id": "iam.roles.list",
+ "path": "v1/roles",
+ "description": "Lists the Roles defined on a resource.",
+ "response": {
+ "$ref": "ListRolesResponse"
},
- "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."
+ "parameterOrder": [],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "roles": {
+ "methods": {
+ "patch": {
+ "id": "iam.organizations.roles.patch",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Role"
+ },
+ "description": "Updates a Role definition.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "A mask describing which fields in the Role have changed.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
+ },
+ "undelete": {
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete",
+ "id": "iam.organizations.roles.undelete",
+ "path": "v1/{+name}:undelete",
+ "description": "Undelete a Role, bringing it back in its previous state.",
+ "request": {
+ "$ref": "UndeleteRoleRequest"
+ },
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST"
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.organizations.roles.get",
+ "description": "Gets a Role definition.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Role"
+ }
+ },
+ "delete": {
+ "id": "iam.organizations.roles.delete",
+ "path": "v1/{+name}",
+ "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
+ "response": {
+ "$ref": "Role"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ },
+ "etag": {
+ "location": "query",
+ "format": "byte",
+ "description": "Used to perform a consistent read-modify-write.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
+ },
+ "list": {
+ "description": "Lists the Roles defined on a resource.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListRolesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token returned in an earlier ListRolesResponse.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional limit on the number of roles to include in the response.",
+ "type": "integer"
+ },
+ "view": {
+ "description": "Optional view for the returned Role objects.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ },
+ "parent": {
+ "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "showDeleted": {
+ "location": "query",
+ "description": "Include Roles that have been deleted.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles",
+ "path": "v1/{+parent}/roles",
+ "id": "iam.organizations.roles.list"
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateRoleRequest"
+ },
+ "description": "Creates a new Role.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles",
+ "id": "iam.organizations.roles.create",
+ "path": "v1/{+parent}/roles"
+ }
+ }
}
}
}
},
"parameters": {
- "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"
},
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
"location": "query"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
+ "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",
@@ -1668,35 +1683,20 @@
"location": "query"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
+ "type": "boolean",
+ "location": "query"
}
},
"version": "v1",
"baseUrl": "https://iam.googleapis.com/",
"servicePath": "",
- "kind": "discovery#restDescription",
"description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.",
- "basePath": "",
- "id": "iam:v1",
- "documentationLink": "https://cloud.google.com/iam/",
- "revision": "20170811",
- "discoveryVersion": "v1"
+ "kind": "discovery#restDescription"
}
diff --git a/kgsearch/v1/kgsearch-api.json b/kgsearch/v1/kgsearch-api.json
index 598814e..cd6a4d3 100644
--- a/kgsearch/v1/kgsearch-api.json
+++ b/kgsearch/v1/kgsearch-api.json
@@ -1,25 +1,41 @@
{
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "version_module": "True",
"resources": {
"entities": {
"methods": {
"search": {
- "path": "v1/entities:search",
- "id": "kgsearch.entities.search",
- "description": "Searches Knowledge Graph for entities that match the constraints.\nA list of matched entities will be returned in response, which will be in\nJSON-LD format and compatible with http://schema.org",
- "httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "SearchResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
+ "ids": {
+ "location": "query",
+ "description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A&ids=B",
+ "type": "string",
+ "repeated": true
+ },
+ "limit": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Limits the number of entities to be returned."
+ },
+ "prefix": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Enables prefix match against names and aliases of entities"
+ },
+ "query": {
+ "location": "query",
+ "description": "The literal query string for search.",
+ "type": "string"
+ },
"types": {
- "repeated": true,
"location": "query",
"description": "Restricts returned entities with these types, e.g. Person\n(as defined in http://schema.org/Person). If multiple types are specified,\nreturned entities will contain one or more of these types.",
- "type": "string"
+ "type": "string",
+ "repeated": true
},
"indent": {
"location": "query",
@@ -27,56 +43,44 @@
"type": "boolean"
},
"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": {
- "repeated": true,
- "location": "query",
- "description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A&ids=B",
- "type": "string"
- },
- "limit": {
- "location": "query",
- "format": "int32",
- "description": "Limits the number of entities to be returned.",
- "type": "integer"
- },
- "prefix": {
- "description": "Enables prefix match against names and aliases of entities",
- "type": "boolean",
- "location": "query"
- },
- "query": {
- "description": "The literal query string for search.",
"type": "string",
- "location": "query"
+ "repeated": true
}
},
- "flatPath": "v1/entities:search"
+ "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"
}
}
}
},
"parameters": {
- "fields": {
+ "upload_protocol": {
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
+ "prettyPrint": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
+ "location": "query",
"enum": [
"1",
"2"
@@ -86,15 +90,14 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ],
- "location": "query"
+ ]
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -103,7 +106,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"key": {
"location": "query",
@@ -116,41 +124,29 @@
"type": "string"
},
"quotaUser": {
+ "type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "boolean"
},
"bearer_token": {
"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"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
}
},
"schemas": {
"SearchResponse": {
- "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.",
"type": "object",
"properties": {
"@type": {
@@ -165,11 +161,12 @@
"type": "array"
},
"@context": {
- "description": "The local context applicable for the response. See more details at\nhttp://www.w3.org/TR/json-ld/#context-definitions.",
- "type": "any"
+ "type": "any",
+ "description": "The local context applicable for the response. See more details at\nhttp://www.w3.org/TR/json-ld/#context-definitions."
}
},
- "id": "SearchResponse"
+ "id": "SearchResponse",
+ "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities."
}
},
"icons": {
@@ -187,8 +184,11 @@
"ownerDomain": "google.com",
"name": "kgsearch",
"batchPath": "batch",
- "id": "kgsearch:v1",
- "documentationLink": "https://developers.google.com/knowledge-graph/",
"revision": "20170109",
- "title": "Knowledge Graph Search API"
+ "documentationLink": "https://developers.google.com/knowledge-graph/",
+ "id": "kgsearch:v1",
+ "title": "Knowledge Graph Search API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": "True"
}
diff --git a/language/v1/language-api.json b/language/v1/language-api.json
index d85ee33..999cf66 100644
--- a/language/v1/language-api.json
+++ b/language/v1/language-api.json
@@ -1,19 +1,658 @@
{
- "revision": "20170822",
+ "resources": {
+ "documents": {
+ "methods": {
+ "analyzeSentiment": {
+ "path": "v1/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "description": "Analyzes the sentiment of the provided text.",
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeSentimentResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:analyzeSentiment"
+ },
+ "annotateText": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnnotateTextResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:annotateText",
+ "path": "v1/documents:annotateText",
+ "id": "language.documents.annotateText",
+ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ }
+ },
+ "analyzeEntities": {
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "path": "v1/documents:analyzeEntities"
+ },
+ "analyzeSyntax": {
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1/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"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://language.googleapis.com/",
+ "servicePath": "",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
"documentationLink": "https://cloud.google.com/natural-language/",
"id": "language:v1",
+ "revision": "20170822",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "AnalyzeSyntaxResponse": {
+ "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.",
+ "extractDocumentSentiment": {
+ "description": "Extract document-level sentiment.",
+ "type": "boolean"
+ },
+ "extractSyntax": {
+ "description": "Extract syntax information.",
+ "type": "boolean"
+ },
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ }
+ },
+ "id": "Features"
+ },
+ "EntityMention": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Proper name",
+ "Common noun (or noun compound)"
+ ],
+ "enum": [
+ "TYPE_UNKNOWN",
+ "PROPER",
+ "COMMON"
+ ],
+ "description": "The type of the entity mention."
+ },
+ "text": {
+ "description": "The mention text.",
+ "$ref": "TextSpan"
+ }
+ },
+ "id": "EntityMention",
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object"
+ },
+ "Sentence": {
+ "description": "Represents a sentence in the input document.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The sentence text.",
+ "$ref": "TextSpan"
+ },
+ "sentiment": {
+ "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence.",
+ "$ref": "Sentiment"
+ }
+ },
+ "id": "Sentence"
+ },
+ "Document": {
+ "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"
+ },
+ "content": {
+ "description": "The content of the input in string format.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PLAIN_TEXT",
+ "HTML"
+ ],
+ "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
+ "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": "Document",
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
+ "type": "object"
+ },
+ "Sentiment": {
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "type": "object",
+ "properties": {
+ "score": {
+ "format": "float",
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
+ "type": "number"
+ },
+ "magnitude": {
+ "format": "float",
+ "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
+ "type": "number"
+ }
+ },
+ "id": "Sentiment"
+ },
+ "AnalyzeEntitiesRequest": {
+ "properties": {
+ "encodingType": {
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "AnalyzeEntitiesRequest",
+ "description": "The entity analysis request message.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "description": "The part of speech tag.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Adjective",
+ "Adposition (preposition and postposition)",
+ "Adverb",
+ "Conjunction",
+ "Determiner",
+ "Noun (common and proper)",
+ "Cardinal number",
+ "Pronoun",
+ "Particle or other function word",
+ "Punctuation",
+ "Verb (all tenses and modes)",
+ "Other: foreign words, typos, abbreviations",
+ "Affix"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ]
+ },
+ "gender": {
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ],
+ "description": "The grammatical gender.",
+ "type": "string",
+ "enumDescriptions": [
+ "Gender is not applicable in the analyzed language or is not predicted.",
+ "Feminine",
+ "Masculine",
+ "Neuter"
+ ]
+ },
+ "person": {
+ "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": {
+ "description": "The grammatical case.",
+ "type": "string",
+ "enumDescriptions": [
+ "Case is not applicable in the analyzed language or is not predicted.",
+ "Accusative",
+ "Adverbial",
+ "Complementive",
+ "Dative",
+ "Genitive",
+ "Instrumental",
+ "Locative",
+ "Nominative",
+ "Oblique",
+ "Partitive",
+ "Prepositional",
+ "Reflexive",
+ "Relative",
+ "Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
+ ]
+ },
+ "tense": {
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ],
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string"
+ },
+ "reciprocity": {
+ "enumDescriptions": [
+ "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
+ "Reciprocal",
+ "Non-reciprocal"
+ ],
+ "enum": [
+ "RECIPROCITY_UNKNOWN",
+ "RECIPROCAL",
+ "NON_RECIPROCAL"
+ ],
+ "description": "The grammatical reciprocity.",
+ "type": "string"
+ },
+ "form": {
+ "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": {
+ "description": "The grammatical number.",
+ "type": "string",
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ],
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ]
+ },
+ "voice": {
+ "enum": [
+ "VOICE_UNKNOWN",
+ "ACTIVE",
+ "CAUSATIVE",
+ "PASSIVE"
+ ],
+ "description": "The grammatical voice.",
+ "type": "string",
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ]
+ }
+ },
+ "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": {
+ "description": "Input document.",
+ "$ref": "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.",
"items": {
- "$ref": "Token"
+ "$ref": "Sentence"
},
"type": "array"
+ }
+ },
+ "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": {
+ "description": "The recognized entities in the input document.",
+ "items": {
+ "$ref": "Entity"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AnalyzeEntitiesResponse"
+ },
+ "AnalyzeSyntaxResponse": {
+ "properties": {
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
@@ -24,6 +663,13 @@
"$ref": "Sentence"
},
"type": "array"
+ },
+ "tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.",
+ "items": {
+ "$ref": "Token"
+ },
+ "type": "array"
}
},
"id": "AnalyzeSyntaxResponse",
@@ -85,12 +731,15 @@
"id": "Entity"
},
"AnnotateTextRequest": {
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "type": "object",
"properties": {
"features": {
- "description": "The enabled features.",
- "$ref": "Features"
+ "$ref": "Features",
+ "description": "The enabled features."
},
"encodingType": {
+ "type": "string",
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
@@ -103,20 +752,24 @@
"UTF16",
"UTF32"
],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ "description": "The encoding type used by the API to calculate offsets."
},
"document": {
- "description": "Input document.",
- "$ref": "Document"
+ "$ref": "Document",
+ "description": "Input document."
}
},
- "id": "AnnotateTextRequest",
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
- "type": "object"
+ "id": "AnnotateTextRequest"
},
"AnnotateTextResponse": {
+ "id": "AnnotateTextResponse",
+ "description": "The text annotations response message.",
+ "type": "object",
"properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
"sentences": {
"description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
"items": {
@@ -141,26 +794,14 @@
"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",
- "description": "The text annotations response message.",
- "type": "object"
+ }
},
"AnalyzeSentimentRequest": {
"description": "The sentiment analysis request message.",
"type": "object",
"properties": {
- "document": {
- "$ref": "Document",
- "description": "Input 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`.",
@@ -173,18 +814,20 @@
"UTF8",
"UTF16",
"UTF32"
- ]
+ ],
+ "description": "The encoding type used by the API to calculate sentence offsets."
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
}
},
"id": "AnalyzeSentimentRequest"
},
"DependencyEdge": {
+ "description": "Represents dependency parse tree information for a token. (For more\ninformation on dependency labels, see\nhttp://www.aclweb.org/anthology/P13-2017",
+ "type": "object",
"properties": {
- "headTokenIndex": {
- "type": "integer",
- "format": "int32",
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index."
- },
"label": {
"enumDescriptions": [
"Unknown",
@@ -346,11 +989,37 @@
],
"description": "The parse label for the token.",
"type": "string"
+ },
+ "headTokenIndex": {
+ "format": "int32",
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
+ "type": "integer"
}
},
- "id": "DependencyEdge",
- "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"
+ "id": "DependencyEdge"
+ },
+ "Token": {
+ "type": "object",
+ "properties": {
+ "partOfSpeech": {
+ "description": "Parts of speech tag for this token.",
+ "$ref": "PartOfSpeech"
+ },
+ "dependencyEdge": {
+ "description": "Dependency tree parse for this token.",
+ "$ref": "DependencyEdge"
+ },
+ "text": {
+ "description": "The token text.",
+ "$ref": "TextSpan"
+ },
+ "lemma": {
+ "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
+ "type": "string"
+ }
+ },
+ "id": "Token",
+ "description": "Represents the smallest syntactic building block of the text."
},
"TextSpan": {
"description": "Represents an output piece of text.",
@@ -362,49 +1031,16 @@
"type": "integer"
},
"content": {
- "type": "string",
- "description": "The content of the output text."
+ "description": "The content of the output text.",
+ "type": "string"
}
},
"id": "TextSpan"
},
- "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."
- },
- "dependencyEdge": {
- "$ref": "DependencyEdge",
- "description": "Dependency tree parse for this token."
- },
- "text": {
- "$ref": "TextSpan",
- "description": "The token text."
- }
- },
- "id": "Token"
- },
"Status": {
- "id": "Status",
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -415,494 +1051,34 @@
}
},
"type": "array"
- }
- }
- },
- "EntityMention": {
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
- "type": "object",
- "properties": {
- "type": {
- "description": "The type of the entity mention.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
- ]
},
- "text": {
- "$ref": "TextSpan",
- "description": "The mention text."
- }
- },
- "id": "EntityMention"
- },
- "Features": {
- "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
- "type": "object",
- "properties": {
- "extractDocumentSentiment": {
- "description": "Extract document-level sentiment.",
- "type": "boolean"
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
},
- "extractSyntax": {
- "description": "Extract syntax information.",
- "type": "boolean"
- },
- "extractEntities": {
- "description": "Extract entities.",
- "type": "boolean"
- }
- },
- "id": "Features"
- },
- "Document": {
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object",
- "properties": {
- "content": {
- "description": "The content of the input in string format.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "PLAIN_TEXT",
- "HTML"
- ],
- "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string"
- },
- "gcsContentUri": {
- "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
- "type": "string"
- },
- "language": {
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
- "id": "Document"
- },
- "Sentence": {
- "description": "Represents a sentence in the input document.",
- "type": "object",
- "properties": {
- "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"
- },
- "text": {
- "$ref": "TextSpan",
- "description": "The sentence text."
- }
- },
- "id": "Sentence"
- },
- "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": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "id": "AnalyzeEntitiesRequest"
- },
- "Sentiment": {
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object",
- "properties": {
- "score": {
- "format": "float",
- "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
- "type": "number"
- },
- "magnitude": {
- "format": "float",
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
- "type": "number"
- }
- },
- "id": "Sentiment"
- },
- "PartOfSpeech": {
- "description": "Represents part of speech information for a token. Parts of speech\nare as defined in\nhttp://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf",
- "type": "object",
- "properties": {
- "form": {
- "description": "The grammatical form.",
- "type": "string",
- "enumDescriptions": [
- "Form is not applicable in the analyzed language or is not predicted.",
- "Adnomial",
- "Auxiliary",
- "Complementizer",
- "Final ending",
- "Gerund",
- "Realis",
- "Irrealis",
- "Short form",
- "Long form",
- "Order form",
- "Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
- ]
- },
- "number": {
- "description": "The grammatical number.",
- "type": "string",
- "enumDescriptions": [
- "Number is not applicable in the analyzed language or is not predicted.",
- "Singular",
- "Plural",
- "Dual"
- ],
- "enum": [
- "NUMBER_UNKNOWN",
- "SINGULAR",
- "PLURAL",
- "DUAL"
- ]
- },
- "voice": {
- "description": "The grammatical voice.",
- "type": "string",
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ],
- "enum": [
- "VOICE_UNKNOWN",
- "ACTIVE",
- "CAUSATIVE",
- "PASSIVE"
- ]
- },
- "aspect": {
- "description": "The grammatical aspect.",
- "type": "string",
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ]
- },
- "mood": {
- "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": {
- "enumDescriptions": [
- "Unknown",
- "Adjective",
- "Adposition (preposition and postposition)",
- "Adverb",
- "Conjunction",
- "Determiner",
- "Noun (common and proper)",
- "Cardinal number",
- "Pronoun",
- "Particle or other function word",
- "Punctuation",
- "Verb (all tenses and modes)",
- "Other: foreign words, typos, abbreviations",
- "Affix"
- ],
- "enum": [
- "UNKNOWN",
- "ADJ",
- "ADP",
- "ADV",
- "CONJ",
- "DET",
- "NOUN",
- "NUM",
- "PRON",
- "PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
- ],
- "description": "The part of speech tag.",
- "type": "string"
- },
- "gender": {
- "enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ],
- "description": "The grammatical gender.",
- "type": "string",
- "enumDescriptions": [
- "Gender is not applicable in the analyzed language or is not predicted.",
- "Feminine",
- "Masculine",
- "Neuter"
- ]
- },
- "person": {
- "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": {
- "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": {
- "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": {
- "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"
- }
- },
- "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": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "AnalyzeSyntaxRequest"
- },
- "AnalyzeSentimentResponse": {
- "type": "object",
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "items": {
- "$ref": "Sentence"
- },
- "type": "array"
- },
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment of the input document."
- }
- },
- "id": "AnalyzeSentimentResponse",
- "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": {
- "description": "The recognized entities in the input document.",
- "items": {
- "$ref": "Entity"
- },
- "type": "array"
- }
- },
- "id": "AnalyzeEntitiesResponse"
+ "id": "Status"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud Natural Language",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloud-language": {
"description": "Apply machine learning models to reveal the structure and meaning of text"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -912,181 +1088,5 @@
"name": "language",
"batchPath": "batch",
"title": "Google Cloud Natural Language API",
- "ownerName": "Google",
- "resources": {
- "documents": {
- "methods": {
- "analyzeSentiment": {
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
- "description": "Analyzes the sentiment of the provided text.",
- "response": {
- "$ref": "AnalyzeSentimentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "path": "v1/documents:analyzeSentiment"
- },
- "annotateText": {
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/documents:annotateText",
- "id": "language.documents.annotateText",
- "path": "v1/documents:annotateText",
- "request": {
- "$ref": "AnnotateTextRequest"
- },
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call."
- },
- "analyzeEntities": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": {
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
- "request": {
- "$ref": "AnalyzeSyntaxRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/documents:analyzeSyntax",
- "path": "v1/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax"
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "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": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://language.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
- "servicePath": "",
- "basePath": ""
+ "ownerName": "Google"
}
diff --git a/language/v1beta1/language-api.json b/language/v1beta1/language-api.json
index 7b7903d..708c1ad 100644
--- a/language/v1beta1/language-api.json
+++ b/language/v1beta1/language-api.json
@@ -6,15 +6,90 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "AnalyzeSyntaxResponse": {
+ "description": "The syntax analysis response message.",
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "sentences": {
+ "description": "Sentences in the input document.",
+ "items": {
+ "$ref": "Sentence"
+ },
+ "type": "array"
+ },
+ "tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.",
+ "items": {
+ "$ref": "Token"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AnalyzeSyntaxResponse"
+ },
+ "Entity": {
+ "properties": {
+ "mentions": {
+ "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
+ "items": {
+ "$ref": "EntityMention"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
+ },
+ "salience": {
+ "format": "float",
+ "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
+ "type": "number"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "Entity",
+ "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
+ "type": "object"
+ },
"AnnotateTextRequest": {
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "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",
@@ -22,7 +97,13 @@
"UTF32"
],
"description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
},
"document": {
"$ref": "Document",
@@ -33,14 +114,21 @@
"$ref": "Features"
}
},
- "id": "AnnotateTextRequest",
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
- "type": "object"
+ "id": "AnnotateTextRequest"
},
"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.",
+ "items": {
+ "$ref": "Entity"
+ },
+ "type": "array"
+ },
+ "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"
@@ -58,20 +146,11 @@
"$ref": "Token"
},
"type": "array"
- },
- "entities": {
- "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
- "items": {
- "$ref": "Entity"
- },
- "type": "array"
- },
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
}
},
- "id": "AnnotateTextResponse"
+ "id": "AnnotateTextResponse",
+ "description": "The text annotations response message.",
+ "type": "object"
},
"AnalyzeSentimentRequest": {
"properties": {
@@ -102,91 +181,7 @@
},
"DependencyEdge": {
"properties": {
- "headTokenIndex": {
- "format": "int32",
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "type": "integer"
- },
"label": {
- "enumDescriptions": [
- "Unknown",
- "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",
@@ -267,7 +262,91 @@
"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": {
+ "format": "int32",
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
+ "type": "integer"
}
},
"id": "DependencyEdge",
@@ -279,12 +358,12 @@
"type": "object",
"properties": {
"partOfSpeech": {
- "$ref": "PartOfSpeech",
- "description": "Parts of speech tag for this token."
+ "description": "Parts of speech tag for this token.",
+ "$ref": "PartOfSpeech"
},
"dependencyEdge": {
- "description": "Dependency tree parse for this token.",
- "$ref": "DependencyEdge"
+ "$ref": "DependencyEdge",
+ "description": "Dependency tree parse for this token."
},
"text": {
"description": "The token text.",
@@ -341,6 +420,8 @@
"type": "object"
},
"Features": {
+ "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
+ "type": "object",
"properties": {
"extractDocumentSentiment": {
"description": "Extract document-level sentiment.",
@@ -355,41 +436,52 @@
"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": {
"type": {
+ "enumDescriptions": [
+ "Unknown",
+ "Proper name",
+ "Common noun (or noun compound)"
+ ],
"enum": [
"TYPE_UNKNOWN",
"PROPER",
"COMMON"
],
"description": "The type of the entity mention.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ]
+ "type": "string"
},
"text": {
- "$ref": "TextSpan",
- "description": "The mention text."
+ "description": "The mention text.",
+ "$ref": "TextSpan"
}
},
"id": "EntityMention"
},
- "Document": {
+ "Sentence": {
+ "description": "Represents a sentence in the input document.",
+ "type": "object",
"properties": {
- "gcsContentUri": {
- "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
- "type": "string"
+ "sentiment": {
+ "$ref": "Sentiment",
+ "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
},
+ "text": {
+ "$ref": "TextSpan",
+ "description": "The sentence text."
+ }
+ },
+ "id": "Sentence"
+ },
+ "Document": {
+ "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"
@@ -399,43 +491,33 @@
"type": "string"
},
"type": {
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ],
"enum": [
"TYPE_UNSPECIFIED",
"PLAIN_TEXT",
"HTML"
],
"description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string",
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ]
- }
- },
- "id": "Document",
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object"
- },
- "Sentence": {
- "description": "Represents a sentence in the input document.",
- "type": "object",
- "properties": {
- "text": {
- "description": "The sentence text.",
- "$ref": "TextSpan"
+ "type": "string"
},
- "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"
+ "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": "Sentence"
+ "id": "Document"
},
"Sentiment": {
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object",
"properties": {
+ "magnitude": {
+ "format": "float",
+ "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
+ "type": "number"
+ },
"score": {
"format": "float",
"description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
@@ -445,18 +527,13 @@
"format": "float",
"description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
"type": "number"
- },
- "magnitude": {
- "format": "float",
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
- "type": "number"
}
},
- "id": "Sentiment"
+ "id": "Sentiment",
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "type": "object"
},
"AnalyzeEntitiesRequest": {
- "description": "The entity analysis request message.",
- "type": "object",
"properties": {
"encodingType": {
"enum": [
@@ -475,242 +552,16 @@
]
},
"document": {
- "description": "Input document.",
- "$ref": "Document"
+ "$ref": "Document",
+ "description": "Input document."
}
},
- "id": "AnalyzeEntitiesRequest"
+ "id": "AnalyzeEntitiesRequest",
+ "description": "The entity analysis request message.",
+ "type": "object"
},
"PartOfSpeech": {
"properties": {
- "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": {
- "enum": [
- "RECIPROCITY_UNKNOWN",
- "RECIPROCAL",
- "NON_RECIPROCAL"
- ],
- "description": "The grammatical reciprocity.",
- "type": "string",
- "enumDescriptions": [
- "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
- "Reciprocal",
- "Non-reciprocal"
- ]
- },
- "form": {
- "enumDescriptions": [
- "Form is not applicable in the analyzed language or is not predicted.",
- "Adnomial",
- "Auxiliary",
- "Complementizer",
- "Final ending",
- "Gerund",
- "Realis",
- "Irrealis",
- "Short form",
- "Long form",
- "Order form",
- "Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
- ],
- "description": "The grammatical form.",
- "type": "string"
- },
- "number": {
- "enumDescriptions": [
- "Number is not applicable in the analyzed language or is not predicted.",
- "Singular",
- "Plural",
- "Dual"
- ],
- "enum": [
- "NUMBER_UNKNOWN",
- "SINGULAR",
- "PLURAL",
- "DUAL"
- ],
- "description": "The grammatical number.",
- "type": "string"
- },
- "voice": {
- "enum": [
- "VOICE_UNKNOWN",
- "ACTIVE",
- "CAUSATIVE",
- "PASSIVE"
- ],
- "description": "The grammatical voice.",
- "type": "string",
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ]
- },
- "aspect": {
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ],
- "description": "The grammatical aspect.",
- "type": "string"
- },
- "mood": {
- "enum": [
- "MOOD_UNKNOWN",
- "CONDITIONAL_MOOD",
- "IMPERATIVE",
- "INDICATIVE",
- "INTERROGATIVE",
- "JUSSIVE",
- "SUBJUNCTIVE"
- ],
- "description": "The grammatical mood.",
- "type": "string",
- "enumDescriptions": [
- "Mood is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Imperative",
- "Indicative",
- "Interrogative",
- "Jussive",
- "Subjunctive"
- ]
- },
- "tag": {
- "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",
@@ -742,6 +593,234 @@
],
"description": "The grammatical properness.",
"type": "string"
+ },
+ "case": {
+ "enumDescriptions": [
+ "Case is not applicable in the analyzed language or is not predicted.",
+ "Accusative",
+ "Adverbial",
+ "Complementive",
+ "Dative",
+ "Genitive",
+ "Instrumental",
+ "Locative",
+ "Nominative",
+ "Oblique",
+ "Partitive",
+ "Prepositional",
+ "Reflexive",
+ "Relative",
+ "Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
+ ],
+ "description": "The grammatical case.",
+ "type": "string"
+ },
+ "tense": {
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string",
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ]
+ },
+ "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": {
+ "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": {
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ],
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ],
+ "description": "The grammatical number.",
+ "type": "string"
+ },
+ "voice": {
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ],
+ "enum": [
+ "VOICE_UNKNOWN",
+ "ACTIVE",
+ "CAUSATIVE",
+ "PASSIVE"
+ ],
+ "description": "The grammatical voice.",
+ "type": "string"
+ },
+ "aspect": {
+ "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": {
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ],
+ "description": "The grammatical gender.",
+ "type": "string",
+ "enumDescriptions": [
+ "Gender is not applicable in the analyzed language or is not predicted.",
+ "Feminine",
+ "Masculine",
+ "Neuter"
+ ]
}
},
"id": "PartOfSpeech",
@@ -776,9 +855,11 @@
"id": "AnalyzeSyntaxRequest"
},
"AnalyzeSentimentResponse": {
- "description": "The sentiment analysis response message.",
- "type": "object",
"properties": {
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment of the input document."
+ },
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
@@ -789,116 +870,35 @@
"$ref": "Sentence"
},
"type": "array"
- },
- "documentSentiment": {
- "description": "The overall sentiment of the input document.",
- "$ref": "Sentiment"
}
},
- "id": "AnalyzeSentimentResponse"
+ "id": "AnalyzeSentimentResponse",
+ "description": "The sentiment analysis response message.",
+ "type": "object"
},
"AnalyzeEntitiesResponse": {
- "description": "The entity analysis response message.",
- "type": "object",
"properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
"entities": {
"description": "The recognized entities in the input document.",
"items": {
"$ref": "Entity"
},
"type": "array"
- }
- },
- "id": "AnalyzeEntitiesResponse"
- },
- "AnalyzeSyntaxResponse": {
- "properties": {
+ },
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
- },
- "sentences": {
- "description": "Sentences in the input document.",
- "items": {
- "$ref": "Sentence"
- },
- "type": "array"
- },
- "tokens": {
- "description": "Tokens, along with their syntactic information, in the input document.",
- "items": {
- "$ref": "Token"
- },
- "type": "array"
}
},
- "id": "AnalyzeSyntaxResponse",
- "description": "The syntax analysis response message.",
- "type": "object"
- },
- "Entity": {
- "properties": {
- "mentions": {
- "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
- "items": {
- "$ref": "EntityMention"
- },
- "type": "array"
- },
- "name": {
- "description": "The representative name for the entity.",
- "type": "string"
- },
- "salience": {
- "format": "float",
- "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
- "type": "number"
- },
- "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"
- },
- "type": {
- "enum": [
- "UNKNOWN",
- "PERSON",
- "LOCATION",
- "ORGANIZATION",
- "EVENT",
- "WORK_OF_ART",
- "CONSUMER_GOOD",
- "OTHER"
- ],
- "description": "The entity type.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ]
- }
- },
- "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": "AnalyzeEntitiesResponse",
+ "description": "The entity analysis response message.",
"type": "object"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"canonicalName": "Cloud Natural Language",
"auth": {
@@ -923,105 +923,142 @@
"documents": {
"methods": {
"analyzeEntities": {
- "path": "v1beta1/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- },
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "AnalyzeEntitiesResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
- "flatPath": "v1beta1/documents:analyzeEntities"
+ "flatPath": "v1beta1/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "path": "v1beta1/documents:analyzeEntities",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties."
},
"analyzeSyntax": {
- "httpMethod": "POST",
- "parameterOrder": [],
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
+ "request": {
+ "$ref": "AnalyzeSyntaxRequest"
+ },
"response": {
"$ref": "AnalyzeSyntaxResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/documents:analyzeSyntax",
- "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"
- }
+ "path": "v1beta1/documents:analyzeSyntax"
},
"analyzeSentiment": {
- "id": "language.documents.analyzeSentiment",
- "path": "v1beta1/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-language",
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
- "flatPath": "v1beta1/documents:analyzeSentiment"
+ "flatPath": "v1beta1/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "path": "v1beta1/documents:analyzeSentiment",
+ "description": "Analyzes the sentiment of the provided text.",
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ }
},
"annotateText": {
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
- "request": {
- "$ref": "AnnotateTextRequest"
- },
"response": {
"$ref": "AnnotateTextResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {},
"flatPath": "v1beta1/documents:annotateText",
"id": "language.documents.annotateText",
- "path": "v1beta1/documents:annotateText"
+ "path": "v1beta1/documents:annotateText",
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ },
+ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call."
}
}
}
},
"parameters": {
- "oauth_token": {
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "OAuth access token.",
"type": "string"
},
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"uploadType": {
"location": "query",
@@ -1029,13 +1066,8 @@
"type": "string"
},
"fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
"location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"$.xgafv": {
@@ -1051,47 +1083,15 @@
"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"
- ],
+ "callback": {
"location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "description": "JSONP",
"type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
}
},
"version": "v1beta1",
"baseUrl": "https://language.googleapis.com/",
- "servicePath": "",
+ "kind": "discovery#restDescription",
"description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
- "kind": "discovery#restDescription"
+ "servicePath": ""
}
diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json
index 115beac..d99076b 100644
--- a/language/v1beta2/language-api.json
+++ b/language/v1beta2/language-api.json
@@ -1,37 +1,178 @@
{
- "servicePath": "",
- "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "revision": "20170822",
- "documentationLink": "https://cloud.google.com/natural-language/",
- "id": "language:v1beta2",
- "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Sentiment": {
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "Token": {
"type": "object",
"properties": {
- "score": {
- "format": "float",
- "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
- "type": "number"
+ "partOfSpeech": {
+ "$ref": "PartOfSpeech",
+ "description": "Parts of speech tag for this token."
},
- "magnitude": {
- "format": "float",
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
- "type": "number"
+ "dependencyEdge": {
+ "$ref": "DependencyEdge",
+ "description": "Dependency tree parse for this token."
+ },
+ "text": {
+ "description": "The token text.",
+ "$ref": "TextSpan"
+ },
+ "lemma": {
+ "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
+ "type": "string"
}
},
- "id": "Sentiment"
+ "id": "Token",
+ "description": "Represents the smallest syntactic building block of the text."
+ },
+ "TextSpan": {
+ "type": "object",
+ "properties": {
+ "beginOffset": {
+ "format": "int32",
+ "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
+ "type": "integer"
+ },
+ "content": {
+ "description": "The content of the output text.",
+ "type": "string"
+ }
+ },
+ "id": "TextSpan",
+ "description": "Represents an output piece of text."
+ },
+ "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": {
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
+ },
+ "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"
+ },
+ "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": {
+ "extractEntitySentiment": {
+ "description": "Extract entities and their associated sentiment.",
+ "type": "boolean"
+ },
+ "extractDocumentSentiment": {
+ "description": "Extract document-level sentiment.",
+ "type": "boolean"
+ },
+ "extractSyntax": {
+ "description": "Extract syntax information.",
+ "type": "boolean"
+ },
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ }
+ },
+ "id": "Features"
+ },
+ "EntityMention": {
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Unknown",
+ "Proper name",
+ "Common noun (or noun compound)"
+ ],
+ "enum": [
+ "TYPE_UNKNOWN",
+ "PROPER",
+ "COMMON"
+ ],
+ "description": "The type of the entity mention.",
+ "type": "string"
+ },
+ "text": {
+ "$ref": "TextSpan",
+ "description": "The mention text."
+ },
+ "sentiment": {
+ "$ref": "Sentiment",
+ "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document."
+ }
+ },
+ "id": "EntityMention"
+ },
+ "Sentence": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The sentence text.",
+ "$ref": "TextSpan"
+ },
+ "sentiment": {
+ "$ref": "Sentiment",
+ "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
+ }
+ },
+ "id": "Sentence",
+ "description": "Represents a sentence in the input document."
+ },
+ "Document": {
+ "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"
+ },
+ "content": {
+ "description": "The content of the input in string format.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PLAIN_TEXT",
+ "HTML"
+ ],
+ "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
+ "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": "Document"
},
"AnalyzeEntitiesRequest": {
+ "id": "AnalyzeEntitiesRequest",
"description": "The entity analysis request message.",
"type": "object",
"properties": {
"encodingType": {
- "description": "The encoding type used by the API to calculate offsets.",
"type": "string",
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
@@ -44,18 +185,33 @@
"UTF8",
"UTF16",
"UTF32"
- ]
+ ],
+ "description": "The encoding type used by the API to calculate offsets."
},
"document": {
"description": "Input document.",
"$ref": "Document"
}
+ }
+ },
+ "Sentiment": {
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "type": "object",
+ "properties": {
+ "magnitude": {
+ "format": "float",
+ "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
+ "type": "number"
+ },
+ "score": {
+ "format": "float",
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
+ "type": "number"
+ }
},
- "id": "AnalyzeEntitiesRequest"
+ "id": "Sentiment"
},
"AnalyzeEntitySentimentResponse": {
- "description": "The entity-level sentiment analysis response message.",
- "type": "object",
"properties": {
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
@@ -69,11 +225,11 @@
"type": "array"
}
},
- "id": "AnalyzeEntitySentimentResponse"
+ "id": "AnalyzeEntitySentimentResponse",
+ "description": "The entity-level sentiment analysis response message.",
+ "type": "object"
},
"AnalyzeEntitySentimentRequest": {
- "description": "The entity-level sentiment analysis request message.",
- "type": "object",
"properties": {
"encodingType": {
"description": "The encoding type used by the API to calculate offsets.",
@@ -96,188 +252,15 @@
"description": "Input document."
}
},
- "id": "AnalyzeEntitySentimentRequest"
+ "id": "AnalyzeEntitySentimentRequest",
+ "description": "The entity-level sentiment analysis request message.",
+ "type": "object"
},
"PartOfSpeech": {
"description": "Represents part of speech information for a token.",
"type": "object",
"properties": {
- "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": {
- "enumDescriptions": [
- "Form is not applicable in the analyzed language or is not predicted.",
- "Adnomial",
- "Auxiliary",
- "Complementizer",
- "Final ending",
- "Gerund",
- "Realis",
- "Irrealis",
- "Short form",
- "Long form",
- "Order form",
- "Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
- ],
- "description": "The grammatical form.",
- "type": "string"
- },
- "number": {
- "enumDescriptions": [
- "Number is not applicable in the analyzed language or is not predicted.",
- "Singular",
- "Plural",
- "Dual"
- ],
- "enum": [
- "NUMBER_UNKNOWN",
- "SINGULAR",
- "PLURAL",
- "DUAL"
- ],
- "description": "The grammatical number.",
- "type": "string"
- },
- "voice": {
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ],
- "enum": [
- "VOICE_UNKNOWN",
- "ACTIVE",
- "CAUSATIVE",
- "PASSIVE"
- ],
- "description": "The grammatical voice.",
- "type": "string"
- },
- "aspect": {
- "description": "The grammatical aspect.",
- "type": "string",
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ]
- },
- "mood": {
- "description": "The grammatical mood.",
- "type": "string",
- "enumDescriptions": [
- "Mood is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Imperative",
- "Indicative",
- "Interrogative",
- "Jussive",
- "Subjunctive"
- ],
- "enum": [
- "MOOD_UNKNOWN",
- "CONDITIONAL_MOOD",
- "IMPERATIVE",
- "INDICATIVE",
- "INTERROGATIVE",
- "JUSSIVE",
- "SUBJUNCTIVE"
- ]
- },
- "tag": {
- "enumDescriptions": [
- "Unknown",
- "Adjective",
- "Adposition (preposition and postposition)",
- "Adverb",
- "Conjunction",
- "Determiner",
- "Noun (common and proper)",
- "Cardinal number",
- "Pronoun",
- "Particle or other function word",
- "Punctuation",
- "Verb (all tenses and modes)",
- "Other: foreign words, typos, abbreviations",
- "Affix"
- ],
- "enum": [
- "UNKNOWN",
- "ADJ",
- "ADP",
- "ADV",
- "CONJ",
- "DET",
- "NOUN",
- "NUM",
- "PRON",
- "PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
- ],
- "description": "The part of speech tag.",
- "type": "string"
- },
- "gender": {
- "enumDescriptions": [
- "Gender is not applicable in the analyzed language or is not predicted.",
- "Feminine",
- "Masculine",
- "Neuter"
- ],
- "enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ],
- "description": "The grammatical gender.",
- "type": "string"
- },
"person": {
- "enumDescriptions": [
- "Person is not applicable in the analyzed language or is not predicted.",
- "First",
- "Second",
- "Third",
- "Reflexive"
- ],
"enum": [
"PERSON_UNKNOWN",
"FIRST",
@@ -286,11 +269,16 @@
"REFLEXIVE_PERSON"
],
"description": "The grammatical person.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ]
},
"proper": {
- "description": "The grammatical properness.",
- "type": "string",
"enumDescriptions": [
"Proper is not applicable in the analyzed language or is not predicted.",
"Proper",
@@ -300,7 +288,9 @@
"PROPER_UNKNOWN",
"PROPER",
"NOT_PROPER"
- ]
+ ],
+ "description": "The grammatical properness.",
+ "type": "string"
},
"case": {
"enumDescriptions": [
@@ -361,6 +351,174 @@
],
"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": {
+ "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": {
+ "enum": [
+ "VOICE_UNKNOWN",
+ "ACTIVE",
+ "CAUSATIVE",
+ "PASSIVE"
+ ],
+ "description": "The grammatical voice.",
+ "type": "string",
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ]
+ },
+ "aspect": {
+ "enumDescriptions": [
+ "Aspect is not applicable in the analyzed language or is not predicted.",
+ "Perfective",
+ "Imperfective",
+ "Progressive"
+ ],
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "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": {
+ "description": "The part of speech tag.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Adjective",
+ "Adposition (preposition and postposition)",
+ "Adverb",
+ "Conjunction",
+ "Determiner",
+ "Noun (common and proper)",
+ "Cardinal number",
+ "Pronoun",
+ "Particle or other function word",
+ "Punctuation",
+ "Verb (all tenses and modes)",
+ "Other: foreign words, typos, abbreviations",
+ "Affix"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ]
+ },
+ "gender": {
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ],
+ "description": "The grammatical gender.",
+ "type": "string",
+ "enumDescriptions": [
+ "Gender is not applicable in the analyzed language or is not predicted.",
+ "Feminine",
+ "Masculine",
+ "Neuter"
+ ]
}
},
"id": "PartOfSpeech"
@@ -369,7 +527,13 @@
"description": "The syntax analysis request message.",
"type": "object",
"properties": {
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ },
"encodingType": {
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
@@ -381,13 +545,7 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
- },
- "document": {
- "description": "Input document.",
- "$ref": "Document"
+ ]
}
},
"id": "AnalyzeSyntaxRequest"
@@ -396,13 +554,6 @@
"description": "The sentiment analysis response message.",
"type": "object",
"properties": {
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "items": {
- "$ref": "Sentence"
- },
- "type": "array"
- },
"documentSentiment": {
"$ref": "Sentiment",
"description": "The overall sentiment of the input document."
@@ -410,6 +561,13 @@
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
+ },
+ "sentences": {
+ "items": {
+ "$ref": "Sentence"
+ },
+ "type": "array",
+ "description": "The sentiment for all the sentences in the document."
}
},
"id": "AnalyzeSentimentResponse"
@@ -433,24 +591,8 @@
"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": {
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ],
"enum": [
"UNKNOWN",
"PERSON",
@@ -462,14 +604,24 @@
"OTHER"
],
"description": "The entity type.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Person",
+ "Location",
+ "Organization",
+ "Event",
+ "Work of art",
+ "Consumer goods",
+ "Other types"
+ ]
},
"metadata": {
- "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
+ "type": "object"
},
"salience": {
"format": "float",
@@ -477,8 +629,8 @@
"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."
+ "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.",
@@ -486,9 +638,15 @@
"$ref": "EntityMention"
},
"type": "array"
+ },
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
}
},
- "id": "Entity"
+ "id": "Entity",
+ "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
+ "type": "object"
},
"AnalyzeSyntaxResponse": {
"description": "The syntax analysis response message.",
@@ -519,15 +677,44 @@
"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": {
+ "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"
+ "$ref": "Document",
+ "description": "Input document."
},
"features": {
- "description": "The enabled features.",
- "$ref": "Features"
+ "$ref": "Features",
+ "description": "The enabled features."
+ }
+ },
+ "id": "AnnotateTextRequest"
+ },
+ "AnalyzeSentimentRequest": {
+ "description": "The sentiment analysis request message.",
+ "type": "object",
+ "properties": {
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
},
"encodingType": {
+ "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
+ "type": "string",
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
@@ -539,17 +726,23 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ ]
}
},
- "id": "AnnotateTextRequest"
+ "id": "AnalyzeSentimentRequest"
},
"AnnotateTextResponse": {
+ "id": "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.",
+ "items": {
+ "$ref": "Entity"
+ },
+ "type": "array"
+ },
"documentSentiment": {
"$ref": "Sentiment",
"description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
@@ -559,11 +752,11 @@
"type": "string"
},
"sentences": {
- "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
"items": {
"$ref": "Sentence"
},
- "type": "array"
+ "type": "array",
+ "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax."
},
"tokens": {
"description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
@@ -571,56 +764,12 @@
"$ref": "Token"
},
"type": "array"
- },
- "entities": {
- "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
- "items": {
- "$ref": "Entity"
- },
- "type": "array"
}
- },
- "id": "AnnotateTextResponse"
- },
- "AnalyzeSentimentRequest": {
- "description": "The sentiment analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
- "type": "string"
- },
- "document": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "id": "AnalyzeSentimentRequest"
+ }
},
"DependencyEdge": {
- "description": "Represents dependency parse tree information for a token.",
- "type": "object",
"properties": {
- "headTokenIndex": {
- "format": "int32",
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "type": "integer"
- },
"label": {
- "description": "The parse label for the token.",
- "type": "string",
"enumDescriptions": [
"Unknown",
"Abbreviation modifier",
@@ -778,181 +927,24 @@
"NUMC",
"COP",
"DISLOCATED"
- ]
- }
- },
- "id": "DependencyEdge"
- },
- "TextSpan": {
- "description": "Represents an output piece of text.",
- "type": "object",
- "properties": {
- "beginOffset": {
+ ],
+ "description": "The parse label for the token.",
+ "type": "string"
+ },
+ "headTokenIndex": {
"format": "int32",
- "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
"type": "integer"
- },
- "content": {
- "description": "The content of the output text.",
- "type": "string"
}
},
- "id": "TextSpan"
- },
- "Token": {
- "description": "Represents the smallest syntactic building block of the text.",
- "type": "object",
- "properties": {
- "dependencyEdge": {
- "$ref": "DependencyEdge",
- "description": "Dependency tree parse for this token."
- },
- "text": {
- "$ref": "TextSpan",
- "description": "The token text."
- },
- "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"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- }
- },
- "id": "Status"
- },
- "Features": {
- "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
- "type": "object",
- "properties": {
- "extractEntities": {
- "description": "Extract entities.",
- "type": "boolean"
- },
- "extractEntitySentiment": {
- "description": "Extract entities and their associated sentiment.",
- "type": "boolean"
- },
- "extractDocumentSentiment": {
- "description": "Extract document-level sentiment.",
- "type": "boolean"
- },
- "extractSyntax": {
- "description": "Extract syntax information.",
- "type": "boolean"
- }
- },
- "id": "Features"
- },
- "EntityMention": {
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
- ],
- "description": "The type of the entity mention.",
- "type": "string"
- },
- "text": {
- "$ref": "TextSpan",
- "description": "The mention text."
- },
- "sentiment": {
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document.",
- "$ref": "Sentiment"
- }
- },
- "id": "EntityMention"
- },
- "Sentence": {
- "description": "Represents a sentence in the input document.",
- "type": "object",
- "properties": {
- "text": {
- "description": "The sentence text.",
- "$ref": "TextSpan"
- },
- "sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
- }
- },
- "id": "Sentence"
- },
- "Document": {
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object",
- "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"
- },
- "content": {
- "description": "The content of the input in string format.",
- "type": "string"
- },
- "type": {
- "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string",
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "PLAIN_TEXT",
- "HTML"
- ]
- },
- "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"
+ "id": "DependencyEdge",
+ "description": "Represents dependency parse tree information for a token.",
+ "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": "Cloud Natural Language",
@@ -977,13 +969,13 @@
"resources": {
"documents": {
"methods": {
- "annotateText": {
+ "analyzeSentiment": {
"request": {
- "$ref": "AnnotateTextRequest"
+ "$ref": "AnalyzeSentimentRequest"
},
- "description": "A convenience method that provides all syntax, sentiment, entity, and\nclassification features in one call.",
+ "description": "Analyzes the sentiment of the provided text.",
"response": {
- "$ref": "AnnotateTextResponse"
+ "$ref": "AnalyzeSentimentResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
@@ -992,28 +984,47 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
- "flatPath": "v1beta2/documents:annotateText",
- "id": "language.documents.annotateText",
- "path": "v1beta2/documents:annotateText"
+ "flatPath": "v1beta2/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "path": "v1beta2/documents:analyzeSentiment"
},
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [],
+ "annotateText": {
"response": {
- "$ref": "AnalyzeEntitySentimentResponse"
+ "$ref": "AnnotateTextResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"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": {
+ "id": "language.documents.analyzeEntitySentiment",
+ "path": "v1beta2/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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta2/documents:analyzeEntitySentiment"
},
"analyzeEntities": {
"request": {
@@ -1035,52 +1046,80 @@
"id": "language.documents.analyzeEntities"
},
"analyzeSyntax": {
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta2/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1beta2/documents:analyzeSyntax",
"request": {
"$ref": "AnalyzeSyntaxRequest"
},
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
"response": {
"$ref": "AnalyzeSyntaxResponse"
},
"parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax",
- "path": "v1beta2/documents:analyzeSyntax"
- },
- "analyzeSentiment": {
- "description": "Analyzes the sentiment of the provided text.",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
- "response": {
- "$ref": "AnalyzeSentimentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "path": "v1beta2/documents:analyzeSentiment"
+ "httpMethod": "POST"
}
}
}
},
"parameters": {
- "upload_protocol": {
+ "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": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "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.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
@@ -1088,81 +1127,42 @@
"type": "boolean"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"$.xgafv": {
- "enumDescriptions": [
- "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"
+ "v1 error format",
+ "v2 error format"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "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": "v1beta2",
- "baseUrl": "https://language.googleapis.com/"
+ "baseUrl": "https://language.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170822",
+ "documentationLink": "https://cloud.google.com/natural-language/",
+ "id": "language:v1beta2",
+ "discoveryVersion": "v1"
}
diff --git a/logging/v2/logging-api.json b/logging/v2/logging-api.json
index 78f9ce3..a32d92a 100644
--- a/logging/v2/logging-api.json
+++ b/logging/v2/logging-api.json
@@ -1,21 +1,402 @@
{
- "servicePath": "",
- "description": "Writes log entries and manages your Stackdriver Logging configuration.",
- "kind": "discovery#restDescription",
"basePath": "",
- "id": "logging:v2",
"documentationLink": "https://cloud.google.com/logging/docs/",
"revision": "20170821",
+ "id": "logging:v2",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "ListLogEntriesRequest": {
+ "description": "The parameters to ListLogEntries.",
+ "type": "object",
+ "properties": {
+ "orderBy": {
+ "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
+ "type": "string"
+ },
+ "resourceNames": {
+ "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "projectIds": {
+ "description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filter": {
+ "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
+ "type": "integer"
+ }
+ },
+ "id": "ListLogEntriesRequest"
+ },
+ "RequestLog": {
+ "id": "RequestLog",
+ "description": "Complete log information about a single HTTP request to an App Engine application.",
+ "type": "object",
+ "properties": {
+ "versionId": {
+ "description": "Version of the application that handled this request.",
+ "type": "string"
+ },
+ "moduleId": {
+ "description": "Module of the application that handled this request.",
+ "type": "string"
+ },
+ "endTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "Time when the request finished."
+ },
+ "userAgent": {
+ "description": "User agent that made the request.",
+ "type": "string"
+ },
+ "wasLoadingRequest": {
+ "description": "Whether this was a loading request for the instance.",
+ "type": "boolean"
+ },
+ "sourceReference": {
+ "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.",
+ "items": {
+ "$ref": "SourceReference"
+ },
+ "type": "array"
+ },
+ "responseSize": {
+ "type": "string",
+ "format": "int64",
+ "description": "Size in bytes sent back to client by request."
+ },
+ "traceId": {
+ "description": "Stackdriver Trace identifier for this request.",
+ "type": "string"
+ },
+ "line": {
+ "description": "A list of log lines emitted by the application while serving this request.",
+ "items": {
+ "$ref": "LogLine"
+ },
+ "type": "array"
+ },
+ "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": {
+ "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.",
+ "type": "string"
+ },
+ "nickname": {
+ "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.",
+ "type": "string"
+ },
+ "pendingTime": {
+ "format": "google-duration",
+ "description": "Time this request spent in the pending request queue.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
+ "type": "string"
+ },
+ "status": {
+ "format": "int32",
+ "description": "HTTP response status code. Example: 200, 404.",
+ "type": "integer"
+ },
+ "taskName": {
+ "description": "Task name of the request, in the case of an offline request.",
+ "type": "string"
+ },
+ "urlMapEntry": {
+ "description": "File or class that handled the request.",
+ "type": "string"
+ },
+ "instanceIndex": {
+ "format": "int32",
+ "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.",
+ "type": "integer"
+ },
+ "finished": {
+ "description": "Whether this request is finished or active.",
+ "type": "boolean"
+ },
+ "host": {
+ "description": "Internet host and port number of the resource being requested.",
+ "type": "string"
+ },
+ "httpVersion": {
+ "description": "HTTP version of request. Example: \"HTTP/1.1\".",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Time when the request started.",
+ "type": "string"
+ },
+ "latency": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "Latency of the request."
+ },
+ "ip": {
+ "description": "Origin IP address.",
+ "type": "string"
+ },
+ "appId": {
+ "description": "Application that handled this request.",
+ "type": "string"
+ },
+ "appEngineRelease": {
+ "type": "string",
+ "description": "App Engine release version."
+ },
+ "method": {
+ "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
+ "type": "string"
+ },
+ "cost": {
+ "type": "number",
+ "format": "double",
+ "description": "An indication of the relative cost of serving this request."
+ },
+ "instanceId": {
+ "description": "An identifier for the instance that handled the request.",
+ "type": "string"
+ },
+ "megaCycles": {
+ "format": "int64",
+ "description": "Number of CPU megacycles used to process request.",
+ "type": "string"
+ },
+ "first": {
+ "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
+ "type": "boolean"
+ }
+ }
+ },
+ "ListMonitoredResourceDescriptorsResponse": {
+ "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": {
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "type": "array",
+ "description": "A list of resource descriptors."
+ }
+ },
+ "id": "ListMonitoredResourceDescriptorsResponse",
+ "description": "Result returned from ListMonitoredResourceDescriptors."
+ },
+ "SourceReference": {
+ "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
+ "type": "object",
+ "properties": {
+ "repository": {
+ "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "type": "string"
+ }
+ },
+ "id": "SourceReference"
+ },
+ "LogMetric": {
+ "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": {
+ "type": "string",
+ "enumDescriptions": [
+ "Stackdriver Logging API v2.",
+ "Stackdriver Logging API v1."
+ ],
+ "enum": [
+ "V2",
+ "V1"
+ ],
+ "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed."
+ },
+ "filter": {
+ "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.",
+ "type": "string"
+ }
+ },
+ "id": "LogMetric",
+ "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.",
+ "type": "object"
+ },
+ "LogEntryOperation": {
+ "properties": {
+ "first": {
+ "description": "Optional. Set this to True if this is the first log entry in the operation.",
+ "type": "boolean"
+ },
+ "producer": {
+ "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
+ "type": "string"
+ },
+ "last": {
+ "description": "Optional. Set this to True if this is the last log entry in the operation.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
+ "type": "string"
+ }
+ },
+ "id": "LogEntryOperation",
+ "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
+ "type": "object"
+ },
+ "WriteLogEntriesResponse": {
+ "description": "Result returned from WriteLogEntries. empty",
+ "type": "object",
+ "properties": {},
+ "id": "WriteLogEntriesResponse"
+ },
+ "MonitoredResource": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "type": {
+ "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "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": {
+ "outputVersionFormat": {
+ "description": "Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified format version that will default to V2.",
+ "LogEntry version 2 format.",
+ "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"
+ },
+ "includeChildren": {
+ "type": "boolean",
+ "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"
+ },
+ "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": {
+ "format": "google-datetime",
+ "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.",
+ "type": "string"
+ },
+ "writerIdentity": {
+ "type": "string",
+ "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity."
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "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.",
+ "type": "string"
+ }
+ },
+ "id": "LogSink"
+ },
+ "WriteLogEntriesRequest": {
+ "properties": {
+ "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.",
+ "items": {
+ "$ref": "LogEntry"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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",
+ "description": "The parameters to WriteLogEntries.",
+ "type": "object"
+ },
"ListLogsResponse": {
+ "id": "ListLogsResponse",
"description": "Result returned from ListLogs.",
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken."
+ "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\".",
@@ -24,79 +405,6 @@
},
"type": "array"
}
- },
- "id": "ListLogsResponse"
- },
- "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": {
- "requestUrl": {
- "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
- "type": "string"
- },
- "remoteIp": {
- "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
- "type": "string"
- },
- "serverIp": {
- "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
- "type": "string"
- },
- "cacheLookup": {
- "description": "Whether or not a cache lookup was attempted.",
- "type": "boolean"
- },
- "cacheHit": {
- "description": "Whether or not an entity was served from cache (with or without validation).",
- "type": "boolean"
- },
- "cacheValidatedWithOriginServer": {
- "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.",
- "type": "boolean"
- },
- "status": {
- "format": "int32",
- "description": "The response code indicating the status of response. Examples: 200, 404.",
- "type": "integer"
- },
- "referer": {
- "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
- "type": "string"
- },
- "userAgent": {
- "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
- "type": "string"
- },
- "latency": {
- "format": "google-duration",
- "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
- "type": "string"
- },
- "cacheFillBytes": {
- "type": "string",
- "format": "int64",
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted."
- },
- "requestMethod": {
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
- "type": "string"
- },
- "requestSize": {
- "format": "int64",
- "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
- "type": "string"
- },
- "responseSize": {
- "type": "string",
- "format": "int64",
- "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body."
- },
- "protocol": {
- "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
- "type": "string"
- }
}
},
"ListSinksResponse": {
@@ -117,7 +425,80 @@
},
"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": {
+ "serverIp": {
+ "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
+ "type": "string"
+ },
+ "remoteIp": {
+ "type": "string",
+ "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\"."
+ },
+ "cacheLookup": {
+ "description": "Whether or not a cache lookup was attempted.",
+ "type": "boolean"
+ },
+ "cacheHit": {
+ "type": "boolean",
+ "description": "Whether or not an entity was served from cache (with or without validation)."
+ },
+ "cacheValidatedWithOriginServer": {
+ "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.",
+ "type": "boolean"
+ },
+ "status": {
+ "format": "int32",
+ "description": "The response code indicating the status of response. Examples: 200, 404.",
+ "type": "integer"
+ },
+ "referer": {
+ "type": "string",
+ "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)."
+ },
+ "latency": {
+ "format": "google-duration",
+ "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
+ "type": "string"
+ },
+ "userAgent": {
+ "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
+ "type": "string"
+ },
+ "cacheFillBytes": {
+ "type": "string",
+ "format": "int64",
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted."
+ },
+ "requestMethod": {
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
+ "type": "string"
+ },
+ "protocol": {
+ "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
+ "type": "string"
+ },
+ "responseSize": {
+ "format": "int64",
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "type": "string"
+ },
+ "requestSize": {
+ "format": "int64",
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "type": "string"
+ },
+ "requestUrl": {
+ "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
+ "type": "string"
+ }
+ }
+ },
"LabelDescriptor": {
+ "description": "A description of a label.",
"type": "object",
"properties": {
"key": {
@@ -143,20 +524,12 @@
"type": "string"
}
},
- "id": "LabelDescriptor",
- "description": "A description of a label."
+ "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": {
- "labels": {
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array",
- "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"
@@ -172,18 +545,22 @@
"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": {
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array",
+ "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\"."
}
},
"id": "MonitoredResourceDescriptor"
},
"LogEntrySourceLocation": {
- "id": "LogEntrySourceLocation",
- "description": "Additional information about the source code location that produced the log entry.",
- "type": "object",
"properties": {
"file": {
- "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
- "type": "string"
+ "type": "string",
+ "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name."
},
"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).",
@@ -194,22 +571,25 @@
"description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
"type": "string"
}
- }
+ },
+ "id": "LogEntrySourceLocation",
+ "description": "Additional information about the source code location that produced the log entry.",
+ "type": "object"
},
"ListLogEntriesResponse": {
"description": "Result returned from ListLogEntries.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
- "type": "string"
- },
"entries": {
"description": "A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information.",
"items": {
"$ref": "LogEntry"
},
"type": "array"
+ },
+ "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"
@@ -219,22 +599,10 @@
"type": "object",
"properties": {
"logMessage": {
- "description": "App-provided log message.",
- "type": "string"
+ "type": "string",
+ "description": "App-provided log message."
},
"severity": {
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ],
- "description": "Severity of this log entry.",
"type": "string",
"enumDescriptions": [
"(0) The log entry has no assigned severity level.",
@@ -246,7 +614,19 @@
"(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."
},
"sourceLocation": {
"$ref": "SourceLocation",
@@ -270,8 +650,8 @@
"type": "array"
},
"nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
+ "type": "string",
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken."
}
},
"id": "ListLogMetricsResponse",
@@ -279,29 +659,29 @@
"type": "object"
},
"LogEntry": {
- "description": "An individual entry in a log.",
"type": "object",
"properties": {
"protoPayload": {
- "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."
+ "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": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry."
+ "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.",
@@ -324,12 +704,11 @@
"ALERT",
"EMERGENCY"
],
- "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
- "type": "string"
+ "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."
+ "description": "Optional. Source code location information associated with the log entry, if any.",
+ "$ref": "LogEntrySourceLocation"
},
"receiveTimestamp": {
"format": "google-datetime",
@@ -337,9 +716,9 @@
"type": "string"
},
"timestamp": {
+ "type": "string",
"format": "google-datetime",
- "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.",
- "type": "string"
+ "description": "Optional. The time the event described by the log entry occurred. If omitted in a new log entry, Stackdriver Logging will insert the time the log entry is received. Stackdriver Logging might reject log entries whose time stamps are more than a couple of hours in the future. Log entries with time stamps in the past are accepted."
},
"logName": {
"description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
@@ -350,31 +729,32 @@
"description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
},
"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"
},
"jsonPayload": {
- "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
- },
- "insertId": {
- "description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.",
- "type": "string"
+ },
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object"
},
"operation": {
"$ref": "LogEntryOperation",
"description": "Optional. Information about an operation associated with the log entry, if applicable."
},
+ "insertId": {
+ "description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging 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"
}
},
- "id": "LogEntry"
+ "id": "LogEntry",
+ "description": "An individual entry in a log."
},
"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 {}.",
@@ -383,9 +763,12 @@
"id": "Empty"
},
"SourceLocation": {
- "description": "Specifies a location in a source code file.",
"type": "object",
"properties": {
+ "file": {
+ "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
+ "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"
@@ -394,403 +777,17 @@
"format": "int64",
"description": "Line within the source file.",
"type": "string"
- },
- "file": {
- "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
- "type": "string"
}
},
- "id": "SourceLocation"
- },
- "ListLogEntriesRequest": {
- "properties": {
- "projectIds": {
- "description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "filter": {
- "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
- "type": "string"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
- "type": "integer"
- },
- "orderBy": {
- "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
- "type": "string"
- },
- "resourceNames": {
- "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "ListLogEntriesRequest",
- "description": "The parameters to ListLogEntries.",
- "type": "object"
- },
- "RequestLog": {
- "description": "Complete log information about a single HTTP request to an App Engine application.",
- "type": "object",
- "properties": {
- "megaCycles": {
- "format": "int64",
- "description": "Number of CPU megacycles used to process request.",
- "type": "string"
- },
- "first": {
- "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
- "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": {
- "format": "google-datetime",
- "description": "Time when the request finished.",
- "type": "string"
- },
- "userAgent": {
- "description": "User agent that made the request.",
- "type": "string"
- },
- "wasLoadingRequest": {
- "description": "Whether this was a loading request for the instance.",
- "type": "boolean"
- },
- "sourceReference": {
- "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.",
- "items": {
- "$ref": "SourceReference"
- },
- "type": "array"
- },
- "responseSize": {
- "format": "int64",
- "description": "Size in bytes sent back to client by request.",
- "type": "string"
- },
- "traceId": {
- "description": "Stackdriver Trace identifier for this request.",
- "type": "string"
- },
- "line": {
- "items": {
- "$ref": "LogLine"
- },
- "type": "array",
- "description": "A list of log lines emitted by the application while serving this request."
- },
- "taskQueueName": {
- "description": "Queue name of the request, in the case of an offline request.",
- "type": "string"
- },
- "referrer": {
- "description": "Referrer URL of 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."
- },
- "nickname": {
- "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.",
- "type": "string"
- },
- "pendingTime": {
- "format": "google-duration",
- "description": "Time this request spent in the pending request queue.",
- "type": "string"
- },
- "resource": {
- "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
- "type": "string"
- },
- "status": {
- "format": "int32",
- "description": "HTTP response status code. Example: 200, 404.",
- "type": "integer"
- },
- "taskName": {
- "type": "string",
- "description": "Task name of the request, in the case of an offline request."
- },
- "urlMapEntry": {
- "description": "File or class that handled the request.",
- "type": "string"
- },
- "instanceIndex": {
- "format": "int32",
- "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.",
- "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"
- },
- "httpVersion": {
- "description": "HTTP version of request. Example: \"HTTP/1.1\".",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Time when the request started.",
- "type": "string"
- },
- "latency": {
- "format": "google-duration",
- "description": "Latency of the request.",
- "type": "string"
- },
- "ip": {
- "description": "Origin IP address.",
- "type": "string"
- },
- "appId": {
- "description": "Application that handled this request.",
- "type": "string"
- },
- "appEngineRelease": {
- "description": "App Engine release version.",
- "type": "string"
- },
- "method": {
- "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
- "type": "string"
- },
- "cost": {
- "format": "double",
- "description": "An indication of the relative cost of serving this request.",
- "type": "number"
- },
- "instanceId": {
- "description": "An identifier for the instance that handled the request.",
- "type": "string"
- }
- },
- "id": "RequestLog"
- },
- "ListMonitoredResourceDescriptorsResponse": {
- "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.",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "type": "array"
- }
- },
- "id": "ListMonitoredResourceDescriptorsResponse",
- "description": "Result returned from ListMonitoredResourceDescriptors."
- },
- "SourceReference": {
- "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
- "type": "object",
- "properties": {
- "revisionId": {
- "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
- "type": "string"
- },
- "repository": {
- "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
- "type": "string"
- }
- },
- "id": "SourceReference"
- },
- "WriteLogEntriesResponse": {
- "description": "Result returned from WriteLogEntries. empty",
- "type": "object",
- "properties": {},
- "id": "WriteLogEntriesResponse"
- },
- "LogEntryOperation": {
- "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"
- },
- "first": {
- "description": "Optional. Set this to True if this is the first log entry in the operation.",
- "type": "boolean"
- },
- "producer": {
- "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
- "type": "string"
- },
- "last": {
- "description": "Optional. Set this to True if this is the last log entry in the operation.",
- "type": "boolean"
- }
- },
- "id": "LogEntryOperation",
- "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
- "type": "object"
- },
- "LogMetric": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\"."
- },
- "description": {
- "description": "Optional. A description of this metric, which is used in documentation.",
- "type": "string"
- },
- "version": {
- "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.",
- "type": "string",
- "enumDescriptions": [
- "Stackdriver Logging API v2.",
- "Stackdriver Logging API v1."
- ],
- "enum": [
- "V2",
- "V1"
- ]
- },
- "filter": {
- "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.",
- "type": "string"
- }
- },
- "id": "LogMetric",
- "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval."
- },
- "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": {
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "MonitoredResource",
- "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n"
- },
- "WriteLogEntriesRequest": {
- "description": "The parameters to WriteLogEntries.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
- "type": "object"
- },
- "resource": {
- "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry.",
- "$ref": "MonitoredResource"
- },
- "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.",
- "items": {
- "$ref": "LogEntry"
- },
- "type": "array"
- },
- "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"
- },
- "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"
- },
- "LogSink": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.",
- "type": "string"
- },
- "includeChildren": {
- "description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND\nresource.type=gce_instance\n",
- "type": "boolean"
- },
- "destination": {
- "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.",
- "type": "string"
- },
- "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": {
- "format": "google-datetime",
- "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.",
- "type": "string"
- },
- "writerIdentity": {
- "type": "string",
- "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity."
- },
- "startTime": {
- "format": "google-datetime",
- "description": "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.",
- "type": "string"
- },
- "outputVersionFormat": {
- "enumDescriptions": [
- "An unspecified format version that will default to V2.",
- "LogEntry version 2 format.",
- "LogEntry version 1 format."
- ],
- "enum": [
- "VERSION_FORMAT_UNSPECIFIED",
- "V2",
- "V1"
- ],
- "description": "Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.",
- "type": "string"
- }
- },
- "id": "LogSink",
- "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder."
+ "id": "SourceLocation",
+ "description": "Specifies a location in a source code file."
}
},
- "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": "Logging",
"auth": {
"oauth2": {
@@ -824,105 +821,6 @@
"resources": {
"sinks": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "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"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- },
- "parent": {
- "pattern": "^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",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.folders.sinks.list",
- "description": "Lists 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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "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",
- "id": "logging.folders.sinks.create",
- "path": "v2/{+parent}/sinks"
- },
"get": {
"description": "Gets a sink.",
"response": {
@@ -932,21 +830,21 @@
"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\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/sinks/[^/]+$"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
],
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
"flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
"id": "logging.folders.sinks.get",
"path": "v2/{+sinkName}"
@@ -959,6 +857,10 @@
"response": {
"$ref": "LogSink"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
"parameters": {
"uniqueWriterIdentity": {
"location": "query",
@@ -973,23 +875,19 @@
"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.patch",
- "description": "Updates a sink. 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 sink might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- }
- },
- "update": {
- "description": "Updates a sink. 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 sink might also have a new writer_identity; see the unique_writer_identity field.",
"request": {
"$ref": "LogSink"
},
+ "description": "Updates a sink. 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 sink might also have a new writer_identity; see the unique_writer_identity field."
+ },
+ "update": {
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
"response": {
"$ref": "LogSink"
},
@@ -997,60 +895,76 @@
"sinkName"
],
"httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
"parameters": {
"uniqueWriterIdentity": {
+ "type": "boolean",
"location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false."
},
"sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"type": "string",
"required": true,
"pattern": "^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\"."
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
"flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
"id": "logging.folders.sinks.update",
"path": "v2/{+sinkName}"
- }
- }
- },
- "logs": {
- "methods": {
+ },
"delete": {
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "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.",
"httpMethod": "DELETE",
- "parameterOrder": [
- "logName"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "sinkName"
+ ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
"parameters": {
- "logName": {
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/logs/[^/]+$",
+ "sinkName": {
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
"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."
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
}
},
- "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
- "path": "v2/{+logName}",
- "id": "logging.folders.logs.delete"
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}"
},
"list": {
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
"parameters": {
+ "parent": {
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ },
"pageToken": {
"location": "query",
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
@@ -1061,235 +975,12 @@
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"type": "integer",
"location": "query"
- },
- "parent": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/folders/{foldersId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.folders.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListLogsResponse"
- }
- }
- }
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "id": "logging.monitoredResourceDescriptors.list",
- "path": "v2/monitoredResourceDescriptors",
- "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": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/monitoredResourceDescriptors"
- }
- }
- },
- "organizations": {
- "resources": {
- "sinks": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "scopes": [
- "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}",
- "path": "v2/{+sinkName}",
- "id": "logging.organizations.sinks.get",
- "description": "Gets a sink."
- },
- "patch": {
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.organizations.sinks.patch"
- },
- "update": {
- "description": "Updates a sink. 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 sink might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "uniqueWriterIdentity": {
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean",
- "location": "query"
- },
- "sinkName": {
- "pattern": "^organizations/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.organizations.sinks.update"
- },
- "delete": {
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.organizations.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/sinks/[^/]+$"
- }
- }
- },
- "list": {
- "description": "Lists sinks.",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks",
- "id": "logging.organizations.sinks.list",
- "path": "v2/{+parent}/sinks"
+ "flatPath": "v2/folders/{foldersId}/sinks",
+ "id": "logging.folders.sinks.list",
+ "path": "v2/{+parent}/sinks",
+ "description": "Lists sinks."
},
"create": {
"response": {
@@ -1299,37 +990,79 @@
"parent"
],
"httpMethod": "POST",
- "parameters": {
- "uniqueWriterIdentity": {
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean",
- "location": "query"
- },
- "parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
- "flatPath": "v2/organizations/{organizationsId}/sinks",
- "id": "logging.organizations.sinks.create",
+ "parameters": {
+ "parent": {
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
+ },
+ "uniqueWriterIdentity": {
+ "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",
+ "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"
- }
+ },
+ "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."
}
}
},
"logs": {
"methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ },
+ "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/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."
+ },
"delete": {
+ "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.",
"httpMethod": "DELETE",
"parameterOrder": [
@@ -1344,25 +1077,224 @@
],
"parameters": {
"logName": {
- "pattern": "^organizations/[^/]+/logs/[^/]+$",
- "location": "path",
"description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^folders/[^/]+/logs/[^/]+$",
+ "location": "path"
}
- },
- "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
- "path": "v2/{+logName}",
- "id": "logging.organizations.logs.delete"
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "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."
},
- "list": {
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available."
+ }
+ },
+ "flatPath": "v2/monitoredResourceDescriptors",
+ "id": "logging.monitoredResourceDescriptors.list",
+ "path": "v2/monitoredResourceDescriptors",
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "sinks": {
+ "methods": {
+ "create": {
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the 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": "ListLogsResponse"
+ "$ref": "LogSink"
},
"parameterOrder": [
"parent"
],
+ "httpMethod": "POST",
+ "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\".",
+ "type": "string",
+ "required": true
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "id": "logging.organizations.sinks.create",
+ "path": "v2/{+parent}/sinks"
+ },
+ "get": {
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "id": "logging.organizations.sinks.get",
+ "path": "v2/{+sinkName}",
+ "description": "Gets a sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
"httpMethod": "GET",
+ "parameters": {
+ "sinkName": {
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ },
+ "patch": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean"
+ },
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^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.patch",
+ "path": "v2/{+sinkName}",
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.organizations.sinks.update",
+ "description": "Updates a sink. 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 sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ },
+ "delete": {
+ "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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}"
+ },
+ "list": {
+ "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.organizations.sinks.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",
@@ -1370,98 +1302,6 @@
"https://www.googleapis.com/auth/logging.read"
],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/logs",
- "id": "logging.organizations.logs.list",
- "path": "v2/{+parent}/logs",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
- }
- }
- }
- }
- },
- "entries": {
- "methods": {
- "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",
- "id": "logging.entries.list",
- "path": "v2/entries:list",
- "request": {
- "$ref": "ListLogEntriesRequest"
- },
- "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
- "response": {
- "$ref": "ListLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- },
- "write": {
- "flatPath": "v2/entries:write",
- "id": "logging.entries.write",
- "path": "v2/entries:write",
- "request": {
- "$ref": "WriteLogEntriesRequest"
- },
- "description": "Writes log entries to Stackdriver Logging.",
- "response": {
- "$ref": "WriteLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {}
- }
- }
- },
- "projects": {
- "resources": {
- "sinks": {
- "methods": {
- "list": {
- "description": "Lists sinks.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
"location": "query",
"format": "int32",
@@ -1472,8 +1312,224 @@
"description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$",
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "logs": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "logName": {
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/logs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
+ "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."
+ },
+ "list": {
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true
+ },
+ "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",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available."
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/logs"
+ }
+ }
+ }
+ }
+ },
+ "entries": {
+ "methods": {
+ "list": {
+ "id": "logging.entries.list",
+ "path": "v2/entries:list",
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
+ "request": {
+ "$ref": "ListLogEntriesRequest"
+ },
+ "response": {
+ "$ref": "ListLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/entries:list"
+ },
+ "write": {
+ "description": "Writes log entries to Stackdriver Logging.",
+ "request": {
+ "$ref": "WriteLogEntriesRequest"
+ },
+ "response": {
+ "$ref": "WriteLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2/entries:write",
+ "id": "logging.entries.write",
+ "path": "v2/entries:write"
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "sinks": {
+ "methods": {
+ "update": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean"
+ },
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.update",
+ "path": "v2/{+sinkName}",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated sink might also have a new writer_identity; see the unique_writer_identity field."
+ },
+ "delete": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.delete",
+ "path": "v2/{+sinkName}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "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",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
}
},
"scopes": [
@@ -1484,16 +1540,10 @@
],
"flatPath": "v2/projects/{projectsId}/sinks",
"path": "v2/{+parent}/sinks",
- "id": "logging.projects.sinks.list"
+ "id": "logging.projects.sinks.list",
+ "description": "Lists sinks."
},
"create": {
- "flatPath": "v2/projects/{projectsId}/sinks",
- "id": "logging.projects.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"
- },
"response": {
"$ref": "LogSink"
},
@@ -1501,13 +1551,17 @@
"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\".",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "required": true
},
"uniqueWriterIdentity": {
"location": "query",
@@ -1515,12 +1569,25 @@
"type": "boolean"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "id": "logging.projects.sinks.create",
+ "path": "v2/{+parent}/sinks",
+ "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."
},
"get": {
+ "path": "v2/{+sinkName}",
+ "id": "logging.projects.sinks.get",
+ "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",
@@ -1536,17 +1603,7 @@
"pattern": "^projects/[^/]+/sinks/[^/]+$"
}
},
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "id": "logging.projects.sinks.get",
- "path": "v2/{+sinkName}",
- "description": "Gets a sink.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "GET"
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}"
},
"patch": {
"httpMethod": "PATCH",
@@ -1567,11 +1624,11 @@
"type": "boolean"
},
"sinkName": {
- "location": "path",
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
@@ -1581,221 +1638,64 @@
"$ref": "LogSink"
},
"description": "Updates a sink. 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 sink might also have a new writer_identity; see the unique_writer_identity field."
- },
- "update": {
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "sinkName": {
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.update"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "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."
}
}
},
"logs": {
"methods": {
"delete": {
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
"httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"logName"
],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "logName": {
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/logs/[^/]+$"
+ }
+ },
"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.",
- "type": "string",
- "required": true
- }
- },
"flatPath": "v2/projects/{projectsId}/logs/{logsId}",
"path": "v2/{+logName}",
- "id": "logging.projects.logs.delete"
+ "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": {
- "flatPath": "v2/projects/{projectsId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.projects.logs.list",
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "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"
- ],
+ "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- },
"parent": {
"description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
- }
- }
- }
- }
- },
- "metrics": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "metricName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {
- "metricName": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n"
- }
- },
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.delete",
- "description": "Deletes a logs-based metric."
- },
- "get": {
- "description": "Gets a logs-based metric.",
- "httpMethod": "GET",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "LogMetric"
- },
- "parameters": {
- "metricName": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.get"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListLogMetricsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"type": "string",
"location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -1804,13 +1704,16 @@
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
],
- "flatPath": "v2/projects/{projectsId}/metrics",
- "path": "v2/{+parent}/metrics",
- "id": "logging.projects.metrics.list",
- "description": "Lists logs-based metrics."
- },
- "update": {
- "description": "Creates or updates a logs-based metric.",
+ "flatPath": "v2/projects/{projectsId}/logs",
+ "id": "logging.projects.logs.list",
+ "path": "v2/{+parent}/logs"
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "create": {
+ "description": "Creates a logs-based metric.",
"request": {
"$ref": "LogMetric"
},
@@ -1818,35 +1721,9 @@
"$ref": "LogMetric"
},
"parameterOrder": [
- "metricName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "metricName": {
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.update",
- "path": "v2/{+metricName}"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
"parent"
],
- "response": {
- "$ref": "LogMetric"
- },
+ "httpMethod": "POST",
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
@@ -1862,11 +1739,131 @@
"https://www.googleapis.com/auth/logging.write"
],
"flatPath": "v2/projects/{projectsId}/metrics",
- "path": "v2/{+parent}/metrics",
"id": "logging.projects.metrics.create",
- "description": "Creates a logs-based metric.",
+ "path": "v2/{+parent}/metrics"
+ },
+ "delete": {
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.delete",
+ "path": "v2/{+metricName}",
+ "description": "Deletes a logs-based metric.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "DELETE"
+ },
+ "get": {
+ "id": "logging.projects.metrics.get",
+ "path": "v2/{+metricName}",
+ "description": "Gets a logs-based metric.",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "metricName": {
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}"
+ },
+ "list": {
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics",
+ "path": "v2/{+parent}/metrics",
+ "id": "logging.projects.metrics.list",
+ "description": "Lists logs-based metrics.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ]
+ },
+ "update": {
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.update",
+ "path": "v2/{+metricName}",
"request": {
"$ref": "LogMetric"
+ },
+ "description": "Creates or updates a logs-based metric.",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {
+ "metricName": {
+ "location": "path",
+ "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/metrics/[^/]+$"
+ }
}
}
}
@@ -1877,6 +1874,68 @@
"resources": {
"sinks": {
"methods": {
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.sinks.get",
+ "description": "Gets a sink."
+ },
+ "patch": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "id": "logging.billingAccounts.sinks.patch",
+ "path": "v2/{+sinkName}",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated sink might also have a new writer_identity; see the unique_writer_identity field."
+ },
"update": {
"response": {
"$ref": "LogSink"
@@ -1892,11 +1951,11 @@
"type": "boolean"
},
"sinkName": {
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path",
"description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path"
+ "required": true
}
},
"scopes": [
@@ -1912,16 +1971,16 @@
}
},
"delete": {
- "path": "v2/{+sinkName}",
"id": "logging.billingAccounts.sinks.delete",
+ "path": "v2/{+sinkName}",
"description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "sinkName"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
@@ -1938,27 +1997,15 @@
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}"
},
"list": {
+ "description": "Lists sinks.",
"httpMethod": "GET",
- "response": {
- "$ref": "ListSinksResponse"
- },
"parameterOrder": [
"parent"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
"parameters": {
- "parent": {
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true
- },
"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.",
@@ -1969,25 +2016,26 @@
"format": "int32",
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
"type": "integer"
+ },
+ "parent": {
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
"path": "v2/{+parent}/sinks",
- "id": "logging.billingAccounts.sinks.list",
- "description": "Lists sinks."
+ "id": "logging.billingAccounts.sinks.list"
},
"create": {
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the 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",
"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\".",
@@ -1997,9 +2045,9 @@
"location": "path"
},
"uniqueWriterIdentity": {
- "location": "query",
"description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
}
},
"scopes": [
@@ -2007,69 +2055,18 @@
"https://www.googleapis.com/auth/logging.admin"
],
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
+ "path": "v2/{+parent}/sinks",
"id": "logging.billingAccounts.sinks.create",
- "path": "v2/{+parent}/sinks"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.get",
- "description": "Gets a sink."
- },
- "patch": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "uniqueWriterIdentity": {
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean",
- "location": "query"
- },
- "sinkName": {
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "id": "logging.billingAccounts.sinks.patch",
- "path": "v2/{+sinkName}",
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "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"
}
}
}
@@ -2078,13 +2075,13 @@
"methods": {
"delete": {
"description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"logName"
],
- "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
@@ -2099,27 +2096,33 @@
}
},
"flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
- "id": "logging.billingAccounts.logs.delete",
- "path": "v2/{+logName}"
+ "path": "v2/{+logName}",
+ "id": "logging.billingAccounts.logs.delete"
},
"list": {
"flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
- "path": "v2/{+parent}/logs",
"id": "logging.billingAccounts.logs.list",
+ "path": "v2/{+parent}/logs",
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "ListLogsResponse"
},
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
"parameters": {
"pageSize": {
- "type": "integer",
"location": "query",
"format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available."
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
},
"parent": {
"description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
@@ -2133,13 +2136,7 @@
"type": "string",
"location": "query"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ]
+ }
}
}
}
@@ -2147,31 +2144,10 @@
}
},
"parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"location": "query",
@@ -2179,13 +2155,13 @@
"default": "true",
"type": "boolean"
},
- "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": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
@@ -2203,11 +2179,13 @@
"type": "string"
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -2219,9 +2197,7 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "location": "query"
},
"access_token": {
"location": "query",
@@ -2232,8 +2208,32 @@
"location": "query",
"description": "API key. Your API 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": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"version": "v2",
- "baseUrl": "https://logging.googleapis.com/"
+ "baseUrl": "https://logging.googleapis.com/",
+ "servicePath": "",
+ "description": "Writes log entries and manages your Stackdriver Logging configuration.",
+ "kind": "discovery#restDescription"
}
diff --git a/logging/v2/logging-gen.go b/logging/v2/logging-gen.go
index c2e2288..e62cb4a 100644
--- a/logging/v2/logging-gen.go
+++ b/logging/v2/logging-gen.go
@@ -484,9 +484,7 @@
// ListLogEntriesResponse: Result returned from ListLogEntries.
type ListLogEntriesResponse struct {
- // Entries: A list of log entries. If entries is empty, nextPageToken
- // may still be returned, indicating that more entries may exist. See
- // nextPageToken for more information.
+ // Entries: A list of log entries.
Entries []*LogEntry `json:"entries,omitempty"`
// NextPageToken: If there might be more results than those appearing in
@@ -972,8 +970,8 @@
// Example: "projects/my-project/metrics/nginx%2Frequests".
Name string `json:"name,omitempty"`
- // Version: Deprecated. The API version that created or updated this
- // metric. The v2 format is used by default and cannot be changed.
+ // Version: Output only. The API version that created or updated this
+ // metric. This value is currently always set to V2.
//
// Possible values:
// "V2" - Stackdriver Logging API v2.
diff --git a/logging/v2beta1/logging-api.json b/logging/v2beta1/logging-api.json
index 3e745ba..9205bc1 100644
--- a/logging/v2beta1/logging-api.json
+++ b/logging/v2beta1/logging-api.json
@@ -1,114 +1,735 @@
{
- "schemas": {
- "LogEntry": {
- "id": "LogEntry",
- "description": "An individual entry in a log.",
- "type": "object",
- "properties": {
- "labels": {
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
+ "resources": {
+ "entries": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/entries:list",
+ "id": "logging.entries.list",
+ "path": "v2beta1/entries:list",
+ "request": {
+ "$ref": "ListLogEntriesRequest"
+ },
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
+ "response": {
+ "$ref": "ListLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "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": {}
+ },
+ "write": {
+ "response": {
+ "$ref": "WriteLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/entries:write",
+ "id": "logging.entries.write",
+ "path": "v2beta1/entries:write",
+ "request": {
+ "$ref": "WriteLogEntriesRequest"
+ },
+ "description": "Writes log entries to Stackdriver Logging."
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "sinks": {
+ "methods": {
+ "delete": {
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "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.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ]
+ },
+ "get": {
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.get",
+ "path": "v2beta1/{+sinkName}",
+ "description": "Gets a sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "type": "string",
+ "required": true,
+ "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"
+ }
+ },
+ "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",
+ "description": "Lists sinks."
+ },
+ "update": {
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean"
+ },
+ "sinkName": {
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.update",
+ "path": "v2beta1/{+sinkName}"
+ },
+ "create": {
+ "path": "v2beta1/{+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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "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": "v2beta1/projects/{projectsId}/sinks"
+ }
}
},
- "trace": {
- "type": "string",
- "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824"
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/logs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}",
+ "id": "logging.projects.logs.delete",
+ "path": "v2beta1/{+logName}",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ },
+ "list": {
+ "flatPath": "v2beta1/projects/{projectsId}/logs",
+ "id": "logging.projects.logs.list",
+ "path": "v2beta1/{+parent}/logs",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ }
+ }
},
- "severity": {
- "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
- "type": "string",
- "enumDescriptions": [
- "(0) The log entry has no assigned severity level.",
- "(100) Debug or trace information.",
- "(200) Routine information, such as ongoing status or performance.",
- "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
- "(400) Warning events might cause problems.",
- "(500) Error events are likely to cause problems.",
- "(600) Critical events cause more severe problems or outages.",
- "(700) A person must take an action immediately.",
- "(800) One or more systems are unusable."
- ],
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ]
- },
- "sourceLocation": {
- "description": "Optional. Source code location information associated with the log entry, if any.",
- "$ref": "LogEntrySourceLocation"
- },
- "timestamp": {
- "format": "google-datetime",
- "description": "Optional. The time the event described by the log entry occurred. 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.",
- "type": "string"
- },
- "receiveTimestamp": {
- "type": "string",
- "format": "google-datetime",
- "description": "Output only. The time the log entry was received by Stackdriver Logging."
- },
- "logName": {
- "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
- "type": "string"
- },
- "resource": {
- "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.",
- "$ref": "MonitoredResource"
- },
- "httpRequest": {
- "$ref": "HttpRequest",
- "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
- },
- "jsonPayload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
- "type": "object"
- },
- "operation": {
- "$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": {
- "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"
+ "metrics": {
+ "methods": {
+ "update": {
+ "description": "Creates or updates a logs-based metric.",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameters": {
+ "metricName": {
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.update"
+ },
+ "create": {
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics",
+ "path": "v2beta1/{+parent}/metrics",
+ "id": "logging.projects.metrics.create",
+ "description": "Creates a logs-based metric.",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ }
+ },
+ "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",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.delete",
+ "path": "v2beta1/{+metricName}",
+ "description": "Deletes a logs-based metric."
+ },
+ "get": {
+ "description": "Gets a logs-based metric.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameters": {
+ "metricName": {
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.get"
+ },
+ "list": {
+ "id": "logging.projects.metrics.list",
+ "path": "v2beta1/{+parent}/metrics",
+ "description": "Lists logs-based metrics.",
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/metrics"
+ }
}
}
}
},
- "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"
+ "billingAccounts": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}",
+ "path": "v2beta1/{+logName}",
+ "id": "logging.billingAccounts.logs.delete",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$"
+ }
+ }
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available."
+ },
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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"
+ ],
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "httpMethod": "GET"
+ }
+ }
+ }
+ }
},
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "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",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v2beta1/monitoredResourceDescriptors",
+ "id": "logging.monitoredResourceDescriptors.list",
+ "path": "v2beta1/monitoredResourceDescriptors",
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "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": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/organizations/{organizationsId}/logs",
+ "id": "logging.organizations.logs.list",
+ "path": "v2beta1/{+parent}/logs"
+ },
+ "delete": {
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "logName": {
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/logs/[^/]+$"
+ }
+ },
+ "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}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "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.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ }
+ },
+ "version": "v2beta1",
+ "baseUrl": "https://logging.googleapis.com/",
+ "description": "Writes log entries and manages your Stackdriver Logging configuration.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170821",
+ "documentationLink": "https://cloud.google.com/logging/docs/",
+ "id": "logging:v2beta1",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
"SourceLocation": {
- "id": "SourceLocation",
"description": "Specifies a location in a source code file.",
"type": "object",
"properties": {
+ "functionName": {
+ "description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
+ "type": "string"
+ },
"line": {
"format": "int64",
"description": "Line within the source file.",
@@ -117,20 +738,16 @@
"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"
}
- }
+ },
+ "id": "SourceLocation"
},
"ListLogEntriesRequest": {
- "description": "The parameters to ListLogEntries.",
"type": "object",
"properties": {
"orderBy": {
- "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
- "type": "string"
+ "type": "string",
+ "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values."
},
"resourceNames": {
"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.",
@@ -147,25 +764,56 @@
"type": "array"
},
"filter": {
- "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
- "type": "string"
+ "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": {
- "type": "integer",
"format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available."
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
+ "type": "integer"
}
},
- "id": "ListLogEntriesRequest"
+ "id": "ListLogEntriesRequest",
+ "description": "The parameters to ListLogEntries."
},
"RequestLog": {
"description": "Complete log information about a single HTTP request to an App Engine application.",
"type": "object",
"properties": {
+ "ip": {
+ "description": "Origin IP address.",
+ "type": "string"
+ },
+ "appId": {
+ "description": "Application that handled this request.",
+ "type": "string"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release version.",
+ "type": "string"
+ },
+ "method": {
+ "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
+ "type": "string"
+ },
+ "cost": {
+ "format": "double",
+ "description": "An indication of the relative cost of serving this request.",
+ "type": "number"
+ },
+ "instanceId": {
+ "type": "string",
+ "description": "An identifier for the instance that handled the request."
+ },
+ "megaCycles": {
+ "format": "int64",
+ "description": "Number of CPU megacycles used to process request.",
+ "type": "string"
+ },
"first": {
"description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
"type": "boolean"
@@ -188,8 +836,8 @@
"type": "string"
},
"wasLoadingRequest": {
- "type": "boolean",
- "description": "Whether this was a loading request for the instance."
+ "description": "Whether this was a loading request for the instance.",
+ "type": "boolean"
},
"sourceReference": {
"description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.",
@@ -249,8 +897,8 @@
"type": "string"
},
"urlMapEntry": {
- "description": "File or class that handled the request.",
- "type": "string"
+ "type": "string",
+ "description": "File or class that handled the request."
},
"instanceIndex": {
"format": "int32",
@@ -266,8 +914,8 @@
"type": "string"
},
"httpVersion": {
- "type": "string",
- "description": "HTTP version of request. Example: \"HTTP/1.1\"."
+ "description": "HTTP version of request. Example: \"HTTP/1.1\".",
+ "type": "string"
},
"startTime": {
"format": "google-datetime",
@@ -278,106 +926,61 @@
"format": "google-duration",
"description": "Latency of the request.",
"type": "string"
- },
- "ip": {
- "type": "string",
- "description": "Origin IP address."
- },
- "appId": {
- "description": "Application that handled this request.",
- "type": "string"
- },
- "appEngineRelease": {
- "description": "App Engine release version.",
- "type": "string"
- },
- "method": {
- "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
- "type": "string"
- },
- "cost": {
- "format": "double",
- "description": "An indication of the relative cost of serving this request.",
- "type": "number"
- },
- "instanceId": {
- "description": "An identifier for the instance that handled the request.",
- "type": "string"
- },
- "megaCycles": {
- "format": "int64",
- "description": "Number of CPU megacycles used to process request.",
- "type": "string"
}
},
"id": "RequestLog"
},
"ListMonitoredResourceDescriptorsResponse": {
- "description": "Result returned from ListMonitoredResourceDescriptors.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- },
"resourceDescriptors": {
"description": "A list of resource descriptors.",
"items": {
"$ref": "MonitoredResourceDescriptor"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
}
},
- "id": "ListMonitoredResourceDescriptorsResponse"
+ "id": "ListMonitoredResourceDescriptorsResponse",
+ "description": "Result returned from ListMonitoredResourceDescriptors."
},
"SourceReference": {
"description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
"type": "object",
"properties": {
- "revisionId": {
- "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
- "type": "string"
- },
"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"
},
- "LogMetric": {
- "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.",
+ "WriteLogEntriesResponse": {
+ "description": "Result returned from WriteLogEntries. empty",
"type": "object",
- "properties": {
- "filter": {
- "type": "string",
- "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters."
- },
- "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": {
- "enum": [
- "V2",
- "V1"
- ],
- "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.",
- "type": "string",
- "enumDescriptions": [
- "Stackdriver Logging API v2.",
- "Stackdriver Logging API v1."
- ]
- }
- },
- "id": "LogMetric"
+ "properties": {},
+ "id": "WriteLogEntriesResponse"
},
"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": {
+ "type": "string",
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation."
+ },
"first": {
"description": "Optional. Set this to True if this is the first log entry in the operation.",
"type": "boolean"
@@ -385,28 +988,42 @@
"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"
+ }
+ },
+ "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": {
+ "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"
},
- "last": {
- "description": "Optional. Set this to True if this is the last log entry in the operation.",
- "type": "boolean"
+ "description": {
+ "description": "Optional. A description of this metric, which is used in documentation.",
+ "type": "string"
},
- "id": {
- "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
+ "version": {
+ "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.",
+ "type": "string",
+ "enumDescriptions": [
+ "Stackdriver Logging API v2.",
+ "Stackdriver Logging API v1."
+ ],
+ "enum": [
+ "V2",
+ "V1"
+ ]
+ },
+ "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": "LogEntryOperation",
- "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
- "type": "object"
- },
- "WriteLogEntriesResponse": {
- "type": "object",
- "properties": {},
- "id": "WriteLogEntriesResponse",
- "description": "Result returned from WriteLogEntries. empty"
+ "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": {
@@ -415,64 +1032,14 @@
"type": "string"
},
"labels": {
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
"type": "object",
"additionalProperties": {
"type": "string"
- }
- }
- }
- },
- "LogSink": {
- "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.",
- "type": "string"
- },
- "includeChildren": {
- "description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND\nresource.type=gce_instance\n",
- "type": "boolean"
- },
- "destination": {
- "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"
- },
- "endTime": {
- "format": "google-datetime",
- "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.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "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.",
- "type": "string"
- },
- "writerIdentity": {
- "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.",
- "type": "string"
- },
- "outputVersionFormat": {
- "enumDescriptions": [
- "An unspecified format version that will default to V2.",
- "LogEntry version 2 format.",
- "LogEntry version 1 format."
- ],
- "enum": [
- "VERSION_FORMAT_UNSPECIFIED",
- "V2",
- "V1"
- ],
- "description": "Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.",
- "type": "string"
+ },
+ "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\"."
}
},
- "id": "LogSink"
+ "id": "MonitoredResource"
},
"WriteLogEntriesRequest": {
"description": "The parameters to WriteLogEntries.",
@@ -490,15 +1057,15 @@
"type": "string"
},
"partialSuccess": {
- "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, 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."
},
"labels": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry."
+ "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",
@@ -507,79 +1074,77 @@
},
"id": "WriteLogEntriesRequest"
},
- "ListLogsResponse": {
- "type": "object",
+ "LogSink": {
"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.",
+ "includeChildren": {
+ "description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND\nresource.type=gce_instance\n",
+ "type": "boolean"
+ },
+ "destination": {
+ "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.",
"type": "string"
},
+ "filter": {
+ "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. 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": {
+ "format": "google-datetime",
+ "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.",
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "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."
+ },
+ "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": {
+ "enum": [
+ "VERSION_FORMAT_UNSPECIFIED",
+ "V2",
+ "V1"
+ ],
+ "description": "Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified format version that will default to V2.",
+ "LogEntry version 2 format.",
+ "LogEntry version 1 format."
+ ]
+ },
+ "name": {
+ "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.",
+ "type": "string"
+ }
+ },
+ "id": "LogSink",
+ "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.",
+ "type": "object"
+ },
+ "ListLogsResponse": {
+ "description": "Result returned from ListLogs.",
+ "type": "object",
+ "properties": {
"logNames": {
- "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\".",
"items": {
"type": "string"
},
- "type": "array"
- }
- },
- "id": "ListLogsResponse",
- "description": "Result returned from ListLogs."
- },
- "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": {
- "items": {
- "$ref": "LogSink"
- },
"type": "array",
- "description": "A list of sinks."
+ "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\"."
+ },
+ "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": "ListSinksResponse"
+ "id": "ListLogsResponse"
},
"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": {
- "latency": {
- "format": "google-duration",
- "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
- "type": "string"
- },
- "userAgent": {
- "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
- "type": "string"
- },
- "cacheFillBytes": {
- "type": "string",
- "format": "int64",
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted."
- },
- "requestMethod": {
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
- "type": "string"
- },
- "requestSize": {
- "format": "int64",
- "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
- "type": "string"
- },
- "responseSize": {
- "format": "int64",
- "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
- "type": "string"
- },
- "protocol": {
- "type": "string",
- "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\""
- },
"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"
@@ -601,8 +1166,8 @@
"type": "boolean"
},
"cacheValidatedWithOriginServer": {
- "type": "boolean",
- "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True."
+ "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.",
+ "type": "boolean"
},
"status": {
"format": "int32",
@@ -610,13 +1175,65 @@
"type": "integer"
},
"referer": {
- "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
+ "type": "string",
+ "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)."
+ },
+ "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",
+ "format": "google-duration",
+ "description": "The request processing latency on the server, from the time the request was received until the response was sent."
+ },
+ "cacheFillBytes": {
+ "format": "int64",
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "type": "string"
+ },
+ "requestMethod": {
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
+ "type": "string"
+ },
+ "requestSize": {
+ "format": "int64",
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "type": "string"
+ },
+ "responseSize": {
+ "format": "int64",
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "type": "string"
+ },
+ "protocol": {
+ "type": "string",
+ "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\""
+ }
+ },
+ "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"
+ },
+ "ListSinksResponse": {
+ "id": "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": {
+ "items": {
+ "$ref": "LogSink"
+ },
+ "type": "array",
+ "description": "A list of sinks."
}
}
},
"LabelDescriptor": {
- "description": "A description of a label.",
"type": "object",
"properties": {
"key": {
@@ -628,7 +1245,6 @@
"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.",
@@ -639,40 +1255,42 @@
"STRING",
"BOOL",
"INT64"
- ]
+ ],
+ "description": "The type of data that can be assigned to the label."
}
},
- "id": "LabelDescriptor"
+ "id": "LabelDescriptor",
+ "description": "A description of a label."
},
"MonitoredResourceDescriptor": {
- "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
"type": "object",
"properties": {
- "labels": {
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array",
- "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"
- },
"description": {
- "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
- "type": "string"
+ "type": "string",
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation."
},
"displayName": {
"description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
"type": "string"
},
"type": {
- "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
+ "type": "string",
+ "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters."
+ },
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
"type": "string"
}
},
- "id": "MonitoredResourceDescriptor"
+ "id": "MonitoredResourceDescriptor",
+ "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API."
},
"LogEntrySourceLocation": {
"description": "Additional information about the source code location that produced the log entry.",
@@ -683,8 +1301,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": {
"format": "int64",
@@ -717,21 +1335,10 @@
"type": "object",
"properties": {
"logMessage": {
- "type": "string",
- "description": "App-provided log message."
+ "description": "App-provided log message.",
+ "type": "string"
},
"severity": {
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ],
"description": "Severity of this log entry.",
"type": "string",
"enumDescriptions": [
@@ -744,11 +1351,22 @@
"(600) Critical events cause more severe problems or outages.",
"(700) A person must take an action immediately.",
"(800) One or more systems are unusable."
+ ],
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
]
},
"sourceLocation": {
- "description": "Where in the source code this log message was written.",
- "$ref": "SourceLocation"
+ "$ref": "SourceLocation",
+ "description": "Where in the source code this log message was written."
},
"time": {
"format": "google-datetime",
@@ -762,19 +1380,123 @@
"description": "Result returned from ListLogMetrics.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
+ },
"metrics": {
"description": "A list of logs-based metrics.",
"items": {
"$ref": "LogMetric"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
}
},
"id": "ListLogMetricsResponse"
+ },
+ "LogEntry": {
+ "properties": {
+ "timestamp": {
+ "format": "google-datetime",
+ "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.",
+ "type": "string"
+ },
+ "receiveTimestamp": {
+ "format": "google-datetime",
+ "description": "Output only. The time the log entry was received by Stackdriver Logging.",
+ "type": "string"
+ },
+ "logName": {
+ "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
+ "type": "string"
+ },
+ "httpRequest": {
+ "$ref": "HttpRequest",
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
+ },
+ "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."
+ },
+ "jsonPayload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object"
+ },
+ "operation": {
+ "description": "Optional. Information about an operation associated with the log entry, if applicable.",
+ "$ref": "LogEntryOperation"
+ },
+ "insertId": {
+ "description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging 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": {
+ "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "trace": {
+ "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
+ "type": "object"
+ },
+ "severity": {
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ],
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ],
+ "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
+ "type": "string"
+ },
+ "sourceLocation": {
+ "description": "Optional. Source code location information associated with the log entry, if any.",
+ "$ref": "LogEntrySourceLocation"
+ }
+ },
+ "id": "LogEntry",
+ "description": "An individual entry in a log.",
+ "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"
}
},
"icons": {
@@ -809,727 +1531,5 @@
"name": "logging",
"batchPath": "batch",
"title": "Stackdriver Logging API",
- "ownerName": "Google",
- "resources": {
- "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": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "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",
- "parameterOrder": [
- "logName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "logName": {
- "pattern": "^organizations/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2beta1/organizations/{organizationsId}/logs/{logsId}",
- "path": "v2beta1/{+logName}",
- "id": "logging.organizations.logs.delete",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
- },
- "list": {
- "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": {
- "parent": {
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/organizations/{organizationsId}/logs",
- "path": "v2beta1/{+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."
- }
- }
- }
- }
- },
- "entries": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2beta1/entries:list",
- "id": "logging.entries.list",
- "path": "v2beta1/entries:list",
- "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
- "request": {
- "$ref": "ListLogEntriesRequest"
- }
- },
- "write": {
- "response": {
- "$ref": "WriteLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "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",
- "id": "logging.entries.write",
- "path": "v2beta1/entries:write",
- "description": "Writes log entries to Stackdriver Logging.",
- "request": {
- "$ref": "WriteLogEntriesRequest"
- }
- }
- }
- },
- "projects": {
- "resources": {
- "sinks": {
- "methods": {
- "get": {
- "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2beta1/{+sinkName}",
- "id": "logging.projects.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": {
- "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\".",
- "type": "string",
- "required": true
- }
- }
- },
- "list": {
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/sinks",
- "id": "logging.projects.sinks.list",
- "path": "v2beta1/{+parent}/sinks",
- "description": "Lists sinks."
- },
- "update": {
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "flatPath": "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true
- },
- "uniqueWriterIdentity": {
- "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": "v2beta1/projects/{projectsId}/sinks",
- "id": "logging.projects.sinks.create",
- "path": "v2beta1/{+parent}/sinks"
- },
- "delete": {
- "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.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}"
- }
- }
- },
- "logs": {
- "methods": {
- "list": {
- "id": "logging.projects.logs.list",
- "path": "v2beta1/{+parent}/logs",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListLogsResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true
- }
- },
- "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}/logs"
- },
- "delete": {
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "logName": {
- "pattern": "^projects/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}",
- "id": "logging.projects.logs.delete",
- "path": "v2beta1/{+logName}"
- }
- }
- },
- "metrics": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "type": "string",
- "required": true,
- "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}",
- "id": "logging.projects.metrics.delete",
- "path": "v2beta1/{+metricName}",
- "description": "Deletes a logs-based metric."
- },
- "get": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "metricName": {
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.get",
- "path": "v2beta1/{+metricName}",
- "description": "Gets a logs-based metric."
- },
- "list": {
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.list",
- "path": "v2beta1/{+parent}/metrics",
- "description": "Lists logs-based metrics.",
- "response": {
- "$ref": "ListLogMetricsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- }
- }
- },
- "update": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {
- "metricName": {
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.update",
- "path": "v2beta1/{+metricName}",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates or updates a logs-based metric."
- },
- "create": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.create",
- "path": "v2beta1/{+parent}/metrics",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates a logs-based metric."
- }
- }
- }
- }
- },
- "billingAccounts": {
- "resources": {
- "logs": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- },
- "parent": {
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs",
- "id": "logging.billingAccounts.logs.list",
- "path": "v2beta1/{+parent}/logs",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "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.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}",
- "path": "v2beta1/{+logName}",
- "id": "logging.billingAccounts.logs.delete",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "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": {
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response."
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API 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"
- }
- },
- "version": "v2beta1",
- "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": "20170821",
- "id": "logging:v2beta1",
- "discoveryVersion": "v1",
- "version_module": true
+ "ownerName": "Google"
}
diff --git a/logging/v2beta1/logging-gen.go b/logging/v2beta1/logging-gen.go
index c1fc63d..d927641 100644
--- a/logging/v2beta1/logging-gen.go
+++ b/logging/v2beta1/logging-gen.go
@@ -424,7 +424,9 @@
// ListLogEntriesResponse: Result returned from ListLogEntries.
type ListLogEntriesResponse struct {
- // Entries: A list of log entries.
+ // Entries: A list of log entries. If entries is empty, nextPageToken
+ // may still be returned, indicating that more entries may exist. See
+ // nextPageToken for more information.
Entries []*LogEntry `json:"entries,omitempty"`
// NextPageToken: If there might be more results than those appearing in
@@ -910,8 +912,8 @@
// Example: "projects/my-project/metrics/nginx%2Frequests".
Name string `json:"name,omitempty"`
- // Version: Output only. The API version that created or updated this
- // metric. This value is currently always set to V2.
+ // Version: Deprecated. The API version that created or updated this
+ // metric. The v2 format is used by default and cannot be changed.
//
// Possible values:
// "V2" - Stackdriver Logging API v2.
diff --git a/manufacturers/v1/manufacturers-api.json b/manufacturers/v1/manufacturers-api.json
index ef21ded..45d7192 100644
--- a/manufacturers/v1/manufacturers-api.json
+++ b/manufacturers/v1/manufacturers-api.json
@@ -1,250 +1,315 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "accounts": {
+ "resources": {
+ "products": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "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.",
+ "type": "string",
+ "required": true
+ },
+ "parent": {
+ "pattern": "^accounts/[^/]+$",
+ "location": "path",
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "path": "v1/{+parent}/products/{+name}",
+ "id": "manufacturers.accounts.products.delete",
+ "description": "Deletes the product from a Manufacturer Center account."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Product"
+ },
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ },
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "type": "string",
+ "required": true,
+ "pattern": "^accounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "path": "v1/{+parent}/products/{+name}",
+ "id": "manufacturers.accounts.products.get",
+ "description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListProductsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The token returned by the previous request.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of product statuses to return in the response, used for\npaging.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^accounts/[^/]+$",
+ "location": "path",
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products",
+ "id": "manufacturers.accounts.products.list",
+ "path": "v1/{+parent}/products",
+ "description": "Lists all the products in a Manufacturer Center account."
+ },
+ "update": {
+ "response": {
+ "$ref": "Product"
+ },
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "type": "string",
+ "required": true,
+ "pattern": "^accounts/[^/]+$",
+ "location": "path"
+ },
+ "name": {
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "id": "manufacturers.accounts.products.update",
+ "path": "v1/{+parent}/products/{+name}",
+ "request": {
+ "$ref": "Product"
+ },
+ "description": "Inserts or updates the product in a Manufacturer Center account.\n\nThe checks at upload time are minimal. All required attributes need to be\npresent for a product to be valid. Issues may show up later\nafter the API has accepted an update for a product and it is possible to\noverwrite an existing valid product with an invalid product. To detect\nthis, you should retrieve the product and check it for issues once the\nupdated version is available.\n\nInserted or updated products first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof updated products will return the original state of the product."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://manufacturers.googleapis.com/",
+ "servicePath": "",
+ "description": "Public API for managing Manufacturer Center related data.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "revision": "20170808",
+ "documentationLink": "https://developers.google.com/manufacturers/",
+ "id": "manufacturers:v1",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Product": {
- "description": "Product data.",
+ "Attributes": {
+ "description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
"type": "object",
"properties": {
- "productId": {
- "description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
+ "ageGroup": {
+ "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.",
"type": "string"
},
- "uploadedAttributes": {
- "$ref": "Attributes",
- "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds."
+ "productDetail": {
+ "description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
+ "items": {
+ "$ref": "ProductDetail"
+ },
+ "type": "array"
},
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly",
+ "flavor": {
+ "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.",
"type": "string"
},
- "manuallyProvidedAttributes": {
- "$ref": "Attributes",
- "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly"
- },
- "contentLanguage": {
- "description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly",
+ "mpn": {
+ "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.",
"type": "string"
},
- "targetCountry": {
- "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly",
+ "productPageUrl": {
+ "description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage.",
"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"
+ "releaseDate": {
+ "description": "The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release.",
+ "type": "string"
},
- "manuallyDeletedAttributes": {
- "description": "Names of the attributes of the product deleted manually via the\nManufacturer Center UI.\n@OutputOnly",
+ "gtin": {
+ "description": "The Global Trade Item Number (GTIN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#gtin.",
"items": {
"type": "string"
},
"type": "array"
},
- "issues": {
- "description": "A server-generated list of issues associated with the product.\n@OutputOnly",
- "items": {
- "$ref": "Issue"
- },
- "type": "array"
- },
- "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"
- }
- },
- "id": "Product"
- },
- "Capacity": {
- "properties": {
- "unit": {
- "description": "The unit of the capacity, i.e., MB, GB, or TB.",
+ "itemGroupId": {
+ "description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.",
"type": "string"
},
- "value": {
- "format": "int64",
- "description": "The numeric value of the capacity.",
- "type": "string"
- }
- },
- "id": "Capacity",
- "description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
- "type": "object"
- },
- "ListProductsResponse": {
- "type": "object",
- "properties": {
- "products": {
- "description": "List of the products.",
- "items": {
- "$ref": "Product"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of product statuses.",
- "type": "string"
- }
- },
- "id": "ListProductsResponse"
- },
- "ProductDetail": {
- "id": "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.",
+ "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"
},
- "sectionName": {
- "description": "A short section name that can be reused between multiple product details.",
- "type": "string"
- },
- "attributeName": {
- "type": "string",
- "description": "The name of the attribute."
- }
- }
- },
- "FeatureDescription": {
- "description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
- "type": "object",
- "properties": {
- "headline": {
- "description": "A short description of the feature.",
- "type": "string"
- },
- "text": {
- "description": "A detailed description of the feature.",
- "type": "string"
- },
- "image": {
- "$ref": "Image",
- "description": "An optional image describing the feature."
- }
- },
- "id": "FeatureDescription"
- },
- "Issue": {
- "description": "Product issue.",
- "type": "object",
- "properties": {
- "severity": {
- "description": "The severity of the issue.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified severity, never used.",
- "Error severity. The issue prevents the usage of the whole item.",
- "Warning severity. The issue is either one that prevents the usage of the\nattribute that triggered it or one that will soon prevent the usage of\nthe whole item.",
- "Info severity. The issue is one that doesn't require immediate attention.\nIt is, for example, used to communicate which attributes are still\npending review."
- ],
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "ERROR",
- "WARNING",
- "INFO"
- ]
+ "capacity": {
+ "description": "The capacity of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
+ "$ref": "Capacity"
},
"description": {
- "description": "Description of the issue.",
+ "description": "The description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#description.",
"type": "string"
},
- "type": {
- "description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.",
+ "gender": {
+ "description": "The target gender of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#gender.",
"type": "string"
},
- "attribute": {
- "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.",
+ "sizeSystem": {
+ "description": "The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem.",
"type": "string"
},
- "timestamp": {
- "format": "google-datetime",
- "description": "The timestamp when this issue appeared.",
- "type": "string"
- }
- },
- "id": "Issue"
- },
- "Price": {
- "description": "A price.",
- "type": "object",
- "properties": {
- "amount": {
- "description": "The numeric value of the price.",
- "type": "string"
- },
- "currency": {
- "description": "The currency in which the price is denoted.",
- "type": "string"
- }
- },
- "id": "Price"
- },
- "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 `{}`."
- },
- "Image": {
- "type": "object",
- "properties": {
- "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": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "PENDING_PROCESSING",
- "PENDING_CRAWL",
- "OK",
- "ROBOTED",
- "XROBOTED",
- "CRAWL_ERROR",
- "PROCESSING_ERROR",
- "DECODING_ERROR",
- "TOO_BIG",
- "CRAWL_SKIPPED"
- ],
- "description": "The status of the image.\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "Status is unspecified. Should not be used.",
- "Image was uploaded and is being processed.",
- "The image crawl is still pending.",
- "The image was processed and it meets the requirements.",
- "The image URL is protected by robots.txt file and cannot be crawled.",
- "The image URL is protected by X-Robots-Tag and cannot be crawled.",
- "There was an error while crawling the image.",
- "The image cannot be processed.",
- "The image cannot be decoded.",
- "The image is too big.",
- "The image was manually overridden and will not be crawled."
- ]
- },
- "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"
- }
- },
- "id": "Image",
- "description": "An image."
- },
- "Attributes": {
- "description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
- "type": "object",
- "properties": {
"theme": {
"description": "The theme of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#theme.",
"type": "string"
@@ -295,8 +360,8 @@
"type": "string"
},
"suggestedRetailPrice": {
- "$ref": "Price",
- "description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price."
+ "description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price.",
+ "$ref": "Price"
},
"featureDescription": {
"description": "The rich format description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
@@ -315,12 +380,12 @@
"type": "string"
},
"title": {
- "type": "string",
- "description": "The title of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#title."
+ "description": "The title of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#title.",
+ "type": "string"
},
"count": {
- "$ref": "Count",
- "description": "The count of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count."
+ "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.",
@@ -337,90 +402,272 @@
"scent": {
"description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.",
"type": "string"
- },
- "productDetail": {
- "description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
- "items": {
- "$ref": "ProductDetail"
- },
- "type": "array"
- },
- "flavor": {
- "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.",
- "type": "string"
- },
- "ageGroup": {
- "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.",
- "type": "string"
- },
- "mpn": {
- "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.",
- "type": "string"
- },
- "productPageUrl": {
- "description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage.",
- "type": "string"
- },
- "releaseDate": {
- "description": "The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release.",
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "itemGroupId": {
- "description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.",
- "type": "string"
- },
- "productLine": {
- "description": "The name of the group of products related to the product. For more\ninformation, see\nhttps://support.google.com/manufacturers/answer/6124116#productline.",
- "type": "string"
- },
- "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"
}
},
"id": "Attributes"
},
"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": {
"unit": {
"description": "The unit in which these products are counted.",
"type": "string"
},
"value": {
- "type": "string",
"format": "int64",
- "description": "The numeric value of the number of products in a package."
+ "description": "The numeric value of the number of products in a package.",
+ "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.",
+ "type": "object"
+ },
+ "Product": {
+ "description": "Product data.",
+ "type": "object",
+ "properties": {
+ "productId": {
+ "description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
+ "type": "string"
+ },
+ "uploadedAttributes": {
+ "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds.",
+ "$ref": "Attributes"
+ },
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly",
+ "type": "string"
+ },
+ "manuallyProvidedAttributes": {
+ "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly",
+ "$ref": "Attributes"
+ },
+ "contentLanguage": {
+ "description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly",
+ "type": "string"
+ },
+ "targetCountry": {
+ "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
+ "type": "string"
+ },
+ "manuallyDeletedAttributes": {
+ "description": "Names of the attributes of the product deleted manually via the\nManufacturer Center UI.\n@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "issues": {
+ "description": "A server-generated list of issues associated with the product.\n@OutputOnly",
+ "items": {
+ "$ref": "Issue"
+ },
+ "type": "array"
+ },
+ "finalAttributes": {
+ "description": "Final attributes of the product. The final attributes are obtained by\noverriding the uploaded attributes with the manually provided and deleted\nattributes. Google systems only process, evaluate, review, and/or use final\nattributes.\n@OutputOnly",
+ "$ref": "Attributes"
+ }
+ },
+ "id": "Product"
+ },
+ "Capacity": {
+ "properties": {
+ "unit": {
+ "description": "The unit of the capacity, i.e., MB, GB, or TB.",
+ "type": "string"
+ },
+ "value": {
+ "format": "int64",
+ "description": "The numeric value of the capacity.",
+ "type": "string"
+ }
+ },
+ "id": "Capacity",
+ "description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
+ "type": "object"
+ },
+ "ListProductsResponse": {
+ "type": "object",
+ "properties": {
+ "products": {
+ "description": "List of the products.",
+ "items": {
+ "$ref": "Product"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of product statuses.",
+ "type": "string"
+ }
+ },
+ "id": "ListProductsResponse"
+ },
+ "ProductDetail": {
+ "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"
+ },
+ "attributeName": {
+ "description": "The name of the attribute.",
+ "type": "string"
+ }
+ },
+ "id": "ProductDetail",
+ "description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
+ "type": "object"
+ },
+ "Issue": {
+ "properties": {
+ "attribute": {
+ "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.",
+ "type": "string"
+ },
+ "timestamp": {
+ "format": "google-datetime",
+ "description": "The timestamp when this issue appeared.",
+ "type": "string"
+ },
+ "severity": {
+ "enumDescriptions": [
+ "Unspecified severity, never used.",
+ "Error severity. The issue prevents the usage of the whole item.",
+ "Warning severity. The issue is either one that prevents the usage of the\nattribute that triggered it or one that will soon prevent the usage of\nthe whole item.",
+ "Info severity. The issue is one that doesn't require immediate attention.\nIt is, for example, used to communicate which attributes are still\npending review."
+ ],
+ "enum": [
+ "SEVERITY_UNSPECIFIED",
+ "ERROR",
+ "WARNING",
+ "INFO"
+ ],
+ "description": "The severity of the issue.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the issue.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.",
+ "type": "string"
+ }
+ },
+ "id": "Issue",
+ "description": "Product issue.",
+ "type": "object"
+ },
+ "FeatureDescription": {
+ "properties": {
+ "headline": {
+ "description": "A short description of the feature.",
+ "type": "string"
+ },
+ "text": {
+ "description": "A detailed description of the feature.",
+ "type": "string"
+ },
+ "image": {
+ "description": "An optional image describing the feature.",
+ "$ref": "Image"
+ }
+ },
+ "id": "FeatureDescription",
+ "description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
+ "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"
+ },
+ "Price": {
+ "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"
+ }
+ },
+ "id": "Price"
+ },
+ "Image": {
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Type is unspecified. Should not be used.",
+ "The image was crawled from a provided URL.",
+ "The image was uploaded."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CRAWLED",
+ "UPLOADED"
+ ],
+ "description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly",
+ "type": "string"
+ },
+ "imageUrl": {
+ "description": "The URL of the image. For crawled images, this is the provided URL. For\nuploaded images, this is a serving URL from Google if the image has been\nprocessed successfully.",
+ "type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Status is unspecified. Should not be used.",
+ "Image was uploaded and is being processed.",
+ "The image crawl is still pending.",
+ "The image was processed and it meets the requirements.",
+ "The image URL is protected by robots.txt file and cannot be crawled.",
+ "The image URL is protected by X-Robots-Tag and cannot be crawled.",
+ "There was an error while crawling the image.",
+ "The image cannot be processed.",
+ "The image cannot be decoded.",
+ "The image is too big.",
+ "The image was manually overridden and will not be crawled."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PENDING_PROCESSING",
+ "PENDING_CRAWL",
+ "OK",
+ "ROBOTED",
+ "XROBOTED",
+ "CRAWL_ERROR",
+ "PROCESSING_ERROR",
+ "DECODING_ERROR",
+ "TOO_BIG",
+ "CRAWL_SKIPPED"
+ ],
+ "description": "The status of the image.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Image",
+ "description": "An image.",
+ "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": "Manufacturer Center",
"auth": {
"oauth2": {
@@ -435,252 +682,5 @@
"ownerDomain": "google.com",
"name": "manufacturers",
"batchPath": "batch",
- "title": "Manufacturer Center API",
- "ownerName": "Google",
- "resources": {
- "accounts": {
- "resources": {
- "products": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Product"
- },
- "parameterOrder": [
- "parent",
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "parameters": {
- "name": {
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$",
- "location": "path"
- },
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "type": "string",
- "required": true,
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "path": "v1/{+parent}/products/{+name}",
- "id": "manufacturers.accounts.products.get",
- "description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear."
- },
- "list": {
- "description": "Lists all the products in a Manufacturer Center account.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListProductsResponse"
- },
- "parameters": {
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "type": "string",
- "required": true,
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of product statuses to return in the response, used for\npaging.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "flatPath": "v1/accounts/{accountsId}/products",
- "path": "v1/{+parent}/products",
- "id": "manufacturers.accounts.products.list"
- },
- "update": {
- "request": {
- "$ref": "Product"
- },
- "description": "Inserts or updates the product in a Manufacturer Center account.\n\nThe checks at upload time are minimal. All required attributes need to be\npresent for a product to be valid. Issues may show up later\nafter the API has accepted an update for a product and it is possible to\noverwrite an existing valid product with an invalid product. To detect\nthis, you should retrieve the product and check it for issues once the\nupdated version is available.\n\nInserted or updated products first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof updated products will return the original state of the product.",
- "response": {
- "$ref": "Product"
- },
- "parameterOrder": [
- "parent",
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "parameters": {
- "name": {
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$",
- "location": "path"
- },
- "parent": {
- "pattern": "^accounts/[^/]+$",
- "location": "path",
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "id": "manufacturers.accounts.products.update",
- "path": "v1/{+parent}/products/{+name}"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "parent",
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "parameters": {
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "type": "string",
- "required": true,
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- },
- "name": {
- "location": "path",
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "id": "manufacturers.accounts.products.delete",
- "path": "v1/{+parent}/products/{+name}",
- "description": "Deletes the product from a Manufacturer Center account."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "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": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://manufacturers.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Public API for managing Manufacturer Center related data.",
- "basePath": "",
- "revision": "20170808",
- "documentationLink": "https://developers.google.com/manufacturers/",
- "id": "manufacturers:v1",
- "discoveryVersion": "v1"
+ "title": "Manufacturer Center API"
}
diff --git a/ml/v1/ml-api.json b/ml/v1/ml-api.json
index 1ac6454..3b12d6e 100644
--- a/ml/v1/ml-api.json
+++ b/ml/v1/ml-api.json
@@ -1,10 +1,876 @@
{
+ "version": "v1",
+ "baseUrl": "https://ml.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "An API to enable creating and using machine learning models.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170819",
+ "documentationLink": "https://cloud.google.com/ml/",
+ "id": "ml:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "GoogleIamV1__Condition": {
+ "GoogleIamV1_LogConfig_DataAccessOptions": {
+ "properties": {
+ "logMode": {
+ "enum": [
+ "LOG_MODE_UNSPECIFIED",
+ "LOG_FAIL_CLOSED"
+ ],
+ "description": "Whether Gin logging should happen in a fail-closed manner at the caller.\nThis is relevant only in the LocalIAM implementation, for now.",
+ "type": "string",
+ "enumDescriptions": [
+ "Client is not required to write a partial Gin log immediately after\nthe authorization check. If client chooses to write one and it fails,\nclient may either fail open (allow the operation to continue) or\nfail closed (handle as a DENY outcome).",
+ "The application's operation in the context of which this authorization\ncheck is being made may only be performed if it is successfully logged\nto Gin. For instance, the authorization library may satisfy this\nobligation by emitting a partial log entry at authorization check time\nand only returning ALLOW to the application if it succeeds.\n\nIf a matching Rule has this directive, but the client has not indicated\nthat it will honor such requirements, then the IAM check will result in\nauthorization failure by setting CheckPolicyResponse.success=false."
+ ]
+ }
+ },
+ "id": "GoogleIamV1_LogConfig_DataAccessOptions",
+ "description": "Write a Data Access (Gin) log",
+ "type": "object"
+ },
+ "GoogleCloudMlV1__PredictionInput": {
+ "description": "Represents input parameters for a prediction job.",
"type": "object",
"properties": {
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the prediction job in.",
+ "type": "string"
+ },
+ "versionName": {
+ "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": {
+ "description": "Required. The output Google Cloud Storage location.",
+ "type": "string"
+ },
+ "maxWorkerCount": {
+ "type": "string",
+ "format": "int64",
+ "description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified."
+ },
+ "uri": {
+ "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
+ "type": "string"
+ },
+ "dataFormat": {
+ "description": "Required. The format of the input data files.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified format.",
+ "The source file is a text file with instances separated by the\nnew-line character.",
+ "The source file is a TFRecord file.",
+ "The source file is a GZIP-compressed TFRecord file."
+ ],
+ "enum": [
+ "DATA_FORMAT_UNSPECIFIED",
+ "TEXT",
+ "TF_RECORD",
+ "TF_RECORD_GZIP"
+ ]
+ },
+ "batchSize": {
+ "format": "int64",
+ "description": "Optional. Number of records per batch, defaults to 64.\nThe service will buffer batch_size number of records in memory before\ninvoking one Tensorflow prediction call internally. So take the record\nsize and memory available into consideration when setting this parameter.",
+ "type": "string"
+ },
+ "runtimeVersion": {
+ "description": "Optional. The Google Cloud ML runtime version to use for this batch\nprediction. If not set, Google Cloud ML will pick the runtime version used\nduring the CreateVersion request for this model version, or choose the\nlatest stable version when model version information is not available\nsuch as when the model is specified by uri.",
+ "type": "string"
+ },
+ "inputPaths": {
+ "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleCloudMlV1__PredictionInput"
+ },
+ "GoogleCloudMlV1__OperationMetadata": {
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The time the operation was submitted.",
+ "type": "string"
+ },
+ "modelName": {
+ "type": "string",
+ "description": "Contains the name of the model associated with the operation."
+ },
+ "version": {
+ "$ref": "GoogleCloudMlV1__Version",
+ "description": "Contains the version associated with the operation."
+ },
+ "endTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "The time operation processing completed."
+ },
+ "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.",
+ "An operation to update an existing model.",
+ "An operation to update an existing version."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE_VERSION",
+ "DELETE_VERSION",
+ "DELETE_MODEL",
+ "UPDATE_MODEL",
+ "UPDATE_VERSION"
+ ],
+ "description": "The operation type.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The time operation processing started.",
+ "type": "string"
+ },
+ "isCancellationRequested": {
+ "description": "Indicates whether a request to cancel this operation has been made.",
+ "type": "boolean"
+ }
+ },
+ "id": "GoogleCloudMlV1__OperationMetadata",
+ "description": "Represents the metadata of the long-running operation.\n\nNext ID: 9"
+ },
+ "GoogleType__Expr": {
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "expression": {
+ "type": "string",
+ "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported."
+ },
+ "location": {
+ "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
+ "type": "string"
+ },
+ "title": {
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleType__Expr"
+ },
+ "GoogleIamV1__AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logType": {
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ]
+ }
+ },
+ "id": "GoogleIamV1__AuditLogConfig"
+ },
+ "GoogleCloudMlV1__HyperparameterSpec": {
+ "type": "object",
+ "properties": {
+ "maxTrials": {
+ "format": "int32",
+ "description": "Optional. How many training trials should be attempted to optimize\nthe specified hyperparameters.\n\nDefaults to one.",
+ "type": "integer"
+ },
+ "params": {
+ "description": "Required. The set of parameters to tune.",
+ "items": {
+ "$ref": "GoogleCloudMlV1__ParameterSpec"
+ },
+ "type": "array"
+ },
+ "maxParallelTrials": {
+ "format": "int32",
+ "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.",
+ "type": "integer"
+ },
+ "hyperparameterMetricTag": {
+ "description": "Optional. The Tensorflow summary tag name to use for optimizing trials. For\ncurrent versions of Tensorflow, this tag name should exactly match what is\nshown in Tensorboard, including all scopes. For versions of Tensorflow\nprior to 0.12, this should be only the tag passed to tf.Summary.\nBy default, \"training/hptuning/metric\" will be used.",
+ "type": "string"
+ },
+ "goal": {
+ "enum": [
+ "GOAL_TYPE_UNSPECIFIED",
+ "MAXIMIZE",
+ "MINIMIZE"
+ ],
+ "description": "Required. The type of goal to use for tuning. Available types are\n`MAXIMIZE` and `MINIMIZE`.\n\nDefaults to `MAXIMIZE`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Goal Type will default to maximize.",
+ "Maximize the goal metric.",
+ "Minimize the goal metric."
+ ]
+ }
+ },
+ "id": "GoogleCloudMlV1__HyperparameterSpec",
+ "description": "Represents a set of hyperparameters to optimize."
+ },
+ "GoogleCloudMlV1__ListJobsResponse": {
+ "description": "Response message for the ListJobs method.",
+ "type": "object",
+ "properties": {
+ "jobs": {
+ "description": "The list of jobs.",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "type": "array"
+ },
+ "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": {
+ "description": "Request message for the SetDefaultVersion request.",
+ "type": "object",
+ "properties": {},
+ "id": "GoogleCloudMlV1__SetDefaultVersionRequest"
+ },
+ "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": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "GoogleLongrunning__Operation"
+ },
+ "GoogleIamV1__AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "GoogleIamV1__AuditLogConfig"
+ },
+ "type": "array"
+ },
+ "exemptedMembers": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleIamV1__AuditConfig"
+ },
+ "GoogleCloudMlV1__Model": {
+ "properties": {
+ "defaultVersion": {
+ "$ref": "GoogleCloudMlV1__Version",
+ "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault)."
+ },
+ "regions": {
+ "description": "Optional. The list of regions where the model is going to be deployed.\nCurrently only one region per model is supported.\nDefaults to 'us-central1' if nothing is set.\nNote:\n* No matter where a model is deployed, it can always be accessed by\n users from anywhere, both for online and batch prediction.\n* The region for a batch prediction job is set by the region field when\n submitting the batch prediction job and does not take its value from\n this field.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Required. The name specified for the model when it was created.\n\nThe model name must be unique within the project it is created in.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. The description specified for the model when it was created.",
+ "type": "string"
+ },
+ "onlinePredictionLogging": {
+ "description": "Optional. If true, enables StackDriver Logging for online prediction.\nDefault is false.",
+ "type": "boolean"
+ }
+ },
+ "id": "GoogleCloudMlV1__Model",
+ "description": "Represents a machine learning solution.\n\nA model can have multiple versions, each of which is a deployed, trained\nmodel ready to receive prediction requests. The model itself is just a\ncontainer.\n\nNext ID: 8",
+ "type": "object"
+ },
+ "GoogleProtobuf__Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "GoogleProtobuf__Empty"
+ },
+ "GoogleIamV1__TestIamPermissionsRequest": {
+ "id": "GoogleIamV1__TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "GoogleCloudMlV1__CancelJobRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "GoogleCloudMlV1__CancelJobRequest",
+ "description": "Request message for the CancelJob method."
+ },
+ "GoogleCloudMlV1__ListVersionsResponse": {
+ "id": "GoogleCloudMlV1__ListVersionsResponse",
+ "description": "Response message for the ListVersions method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ },
+ "versions": {
+ "description": "The list of versions.",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "GoogleIamV1__LogConfig": {
+ "description": "Specifies what kind of log the caller must write",
+ "type": "object",
+ "properties": {
+ "counter": {
+ "$ref": "GoogleIamV1_LogConfig_CounterOptions",
+ "description": "Counter options."
+ },
+ "dataAccess": {
+ "$ref": "GoogleIamV1_LogConfig_DataAccessOptions",
+ "description": "Data access options."
+ },
+ "cloudAudit": {
+ "$ref": "GoogleIamV1_LogConfig_CloudAuditOptions",
+ "description": "Cloud audit options."
+ }
+ },
+ "id": "GoogleIamV1__LogConfig"
+ },
+ "GoogleRpc__Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "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__AutoScaling": {
+ "description": "Options for automatically scaling a model.",
+ "type": "object",
+ "properties": {
+ "minNodes": {
+ "format": "int32",
+ "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.",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1__AutoScaling"
+ },
+ "GoogleCloudMlV1__TrainingInput": {
+ "properties": {
+ "masterType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a\n \u003ca href=\"/ml-engine/docs/how-tos/using-gpus\"\u003e\n GPU that you can use in your trainer\u003c/a\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four GPUs.\n \u003c/dd\u003e\n\u003c/dl\u003e\n\nYou must set this value when `scaleTier` is set to `CUSTOM`.",
+ "type": "string"
+ },
+ "runtimeVersion": {
+ "description": "Optional. The Google Cloud ML runtime version to use for training. If not\nset, Google Cloud ML will choose the latest stable version.",
+ "type": "string"
+ },
+ "pythonModule": {
+ "description": "Required. The Python module name to run after installing the packages.",
+ "type": "string"
+ },
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the training job in.",
+ "type": "string"
+ },
+ "args": {
+ "description": "Optional. Command line arguments to pass to the program.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "workerType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's worker nodes.\n\nThe supported values are the same as those described in the entry for\n`masterType`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`workerCount` is greater than zero.",
+ "type": "string"
+ },
+ "parameterServerType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's parameter server.\n\nThe supported values are the same as those described in the entry for\n`master_type`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`parameter_server_count` is greater than zero.",
+ "type": "string"
+ },
+ "scaleTier": {
+ "enumDescriptions": [
+ "A single worker instance. This tier is suitable for learning how to use\nCloud ML, and for experimenting with new models using small datasets.",
+ "Many workers and a few parameter servers.",
+ "A large number of workers with many parameter servers.",
+ "A single worker instance [with a\nGPU](/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",
+ "PREMIUM_1",
+ "BASIC_GPU",
+ "CUSTOM"
+ ],
+ "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.",
+ "type": "string"
+ },
+ "jobDir": {
+ "description": "Optional. A Google Cloud Storage path in which to store training outputs\nand other data needed for training. This path is passed to your TensorFlow\nprogram as the 'job_dir' command-line argument. The benefit of specifying\nthis field is that Cloud ML validates the path for use in training.",
+ "type": "string"
+ },
+ "hyperparameters": {
+ "$ref": "GoogleCloudMlV1__HyperparameterSpec",
+ "description": "Optional. The set of Hyperparameters to tune."
+ },
+ "parameterServerCount": {
+ "format": "int64",
+ "description": "Optional. The number of parameter server replicas to use for the training\njob. Each replica in the cluster will be of the type specified in\n`parameter_server_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`.If you\nset this value, you must also set `parameter_server_type`.",
+ "type": "string"
+ },
+ "packageUris": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.\nThe maximum number of package URIs is 100."
+ },
+ "workerCount": {
+ "format": "int64",
+ "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1__TrainingInput",
+ "description": "Represents input parameters for a training job.",
+ "type": "object"
+ },
+ "GoogleCloudMlV1__ListModelsResponse": {
+ "description": "Response message for the ListModels method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call."
+ },
+ "models": {
+ "description": "The list of models.",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleCloudMlV1__ListModelsResponse"
+ },
+ "GoogleCloudMlV1__Job": {
+ "properties": {
+ "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"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Output only. When the job processing was completed.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Output only. When the job processing was started.",
+ "type": "string"
+ },
+ "predictionOutput": {
+ "description": "The current prediction job result.",
+ "$ref": "GoogleCloudMlV1__PredictionOutput"
+ },
+ "trainingOutput": {
+ "$ref": "GoogleCloudMlV1__TrainingOutput",
+ "description": "The current training job result."
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Output only. When the job was created.",
+ "type": "string"
+ },
+ "trainingInput": {
+ "description": "Input parameters to create a training job.",
+ "$ref": "GoogleCloudMlV1__TrainingInput"
+ },
+ "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."
+ ]
+ },
+ "predictionInput": {
+ "description": "Input parameters to create a prediction job.",
+ "$ref": "GoogleCloudMlV1__PredictionInput"
+ }
+ },
+ "id": "GoogleCloudMlV1__Job",
+ "description": "Represents a training or prediction job.\n\nNext ID: 16",
+ "type": "object"
+ },
+ "GoogleApi__HttpBody": {
+ "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.",
+ "type": "object",
+ "properties": {
+ "extensions": {
+ "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ },
+ "data": {
+ "format": "byte",
+ "description": "HTTP body binary data.",
+ "type": "string"
+ },
+ "contentType": {
+ "type": "string",
+ "description": "The HTTP Content-Type string representing the content type of the body."
+ }
+ },
+ "id": "GoogleApi__HttpBody"
+ },
+ "GoogleCloudMlV1__GetConfigResponse": {
+ "description": "Returns service account information associated with a project.",
+ "type": "object",
+ "properties": {
+ "serviceAccountProject": {
+ "format": "int64",
+ "description": "The project number for `service_account`.",
+ "type": "string"
+ },
+ "serviceAccount": {
+ "description": "The service account Cloud ML uses to access resources in the project.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1__GetConfigResponse"
+ },
+ "GoogleIamV1__TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleIamV1__TestIamPermissionsResponse"
+ },
+ "GoogleIamV1__SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "type": "string"
+ },
+ "policy": {
+ "$ref": "GoogleIamV1__Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "GoogleIamV1__SetIamPolicyRequest"
+ },
+ "GoogleCloudMlV1__HyperparameterOutput": {
+ "description": "Represents the result of a single hyperparameter tuning trial from a\ntraining job. The TrainingOutput object that is returned on successful\ncompletion of a training job with hyperparameter tuning includes a list\nof HyperparameterOutput objects, one for each successful trial.",
+ "type": "object",
+ "properties": {
+ "allMetrics": {
+ "description": "All recorded object metrics for this trial.",
+ "items": {
+ "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
+ },
+ "type": "array"
+ },
+ "finalMetric": {
+ "description": "The final objective metric seen for this trial.",
+ "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
+ },
+ "hyperparameters": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The hyperparameters given to this trial.",
+ "type": "object"
+ },
+ "trialId": {
+ "type": "string",
+ "description": "The trial id for these results."
+ }
+ },
+ "id": "GoogleCloudMlV1__HyperparameterOutput"
+ },
+ "GoogleCloudMlV1__PredictionOutput": {
+ "description": "Represents results of a prediction job.",
+ "type": "object",
+ "properties": {
+ "errorCount": {
+ "format": "int64",
+ "description": "The number of data instances which resulted in errors.",
+ "type": "string"
+ },
+ "nodeHours": {
+ "format": "double",
+ "description": "Node hours used by the batch prediction job.",
+ "type": "number"
+ },
+ "outputPath": {
+ "description": "The output Google Cloud Storage location provided at the job creation time.",
+ "type": "string"
+ },
+ "predictionCount": {
+ "format": "int64",
+ "description": "The number of generated predictions.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1__PredictionOutput"
+ },
+ "GoogleIamV1__Policy": {
+ "type": "object",
+ "properties": {
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "items": {
+ "$ref": "GoogleIamV1__AuditConfig"
+ },
+ "type": "array"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "GoogleIamV1__Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "format": "byte",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "type": "string"
+ },
+ "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.",
+ "items": {
+ "$ref": "GoogleIamV1__Rule"
+ },
+ "type": "array"
+ },
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleIamV1__Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam)."
+ },
+ "GoogleLongrunning__ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleLongrunning__ListOperationsResponse"
+ },
+ "GoogleIamV1__Condition": {
+ "description": "A condition to be met.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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).",
+ "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": {
+ "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",
@@ -22,78 +888,56 @@
"Resource name",
"IP address of the caller"
]
+ }
+ },
+ "id": "GoogleIamV1__Condition"
+ },
+ "GoogleCloudMlV1__ManualScaling": {
+ "properties": {
+ "nodes": {
+ "format": "int32",
+ "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.",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1__ManualScaling",
+ "description": "Options for manually scaling a model.",
+ "type": "object"
+ },
+ "GoogleIamV1__Binding": {
+ "type": "object",
+ "properties": {
+ "condition": {
+ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.",
+ "$ref": "GoogleType__Expr"
},
- "value": {
- "description": "DEPRECATED. Use 'values' instead.",
- "type": "string"
- },
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
- "iam": {
- "enum": [
- "NO_ATTR",
- "AUTHORITY",
- "ATTRIBUTION",
- "APPROVER",
- "JUSTIFICATION_TYPE"
- ],
- "description": "Trusted attributes supplied by the IAM system.",
- "type": "string",
- "enumDescriptions": [
- "Default non-attribute.",
- "Either principal or (if present) authority selector.",
- "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
- "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).",
- "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": {
- "type": "string",
- "enumDescriptions": [
- "Default no-op.",
- "DEPRECATED. Use IN instead.",
- "DEPRECATED. Use NOT_IN instead.",
- "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
- "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
- "Subject is discharged"
- ],
- "enum": [
- "NO_OP",
- "EQUALS",
- "NOT_EQUALS",
- "IN",
- "NOT_IN",
- "DISCHARGED"
- ],
- "description": "An operator to apply the subject with."
- },
- "svc": {
- "description": "Trusted attributes discharged by the service.",
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
},
- "id": "GoogleIamV1__Condition",
- "description": "A condition to be met."
- },
- "GoogleCloudMlV1__ManualScaling": {
- "description": "Options for manually scaling a model.",
- "type": "object",
- "properties": {
- "nodes": {
- "type": "integer",
- "format": "int32",
- "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."
- }
- },
- "id": "GoogleCloudMlV1__ManualScaling"
+ "id": "GoogleIamV1__Binding",
+ "description": "Associates `members` with a `role`."
},
"GoogleCloudMlV1__TrainingOutput": {
+ "type": "object",
"properties": {
+ "completedTrialCount": {
+ "format": "int64",
+ "description": "The number of hyperparameter tuning trials that completed successfully.\nOnly set for hyperparameter tuning jobs.",
+ "type": "string"
+ },
+ "isHyperparameterTuningJob": {
+ "description": "Whether this job is a hyperparameter tuning job.",
+ "type": "boolean"
+ },
"consumedMLUnits": {
"format": "double",
"description": "The amount of ML units consumed by the job.",
@@ -105,53 +949,37 @@
"$ref": "GoogleCloudMlV1__HyperparameterOutput"
},
"type": "array"
- },
- "completedTrialCount": {
- "format": "int64",
- "description": "The number of hyperparameter tuning trials that completed successfully.\nOnly set for hyperparameter tuning jobs.",
- "type": "string"
- },
- "isHyperparameterTuningJob": {
- "description": "Whether this job is a hyperparameter tuning job.",
- "type": "boolean"
}
},
"id": "GoogleCloudMlV1__TrainingOutput",
- "description": "Represents results of a training job. Output only.",
- "type": "object"
+ "description": "Represents results of a training job. Output only."
},
- "GoogleIamV1__Binding": {
+ "GoogleIamV1__Rule": {
"properties": {
- "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": "GoogleType__Expr"
- },
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "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).",
"items": {
"type": "string"
},
"type": "array"
- }
- },
- "id": "GoogleIamV1__Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
- },
- "GoogleIamV1__Rule": {
- "description": "A rule to be applied in a Policy.",
- "type": "object",
- "properties": {
+ },
+ "description": {
+ "description": "Human-readable description of the rule.",
+ "type": "string"
+ },
+ "conditions": {
+ "description": "Additional restrictions that must be met",
+ "items": {
+ "$ref": "GoogleIamV1__Condition"
+ },
+ "type": "array"
+ },
"logConfig": {
+ "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
"items": {
"$ref": "GoogleIamV1__LogConfig"
},
- "type": "array",
- "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action."
+ "type": "array"
},
"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.",
@@ -186,27 +1014,11 @@
"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).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "description": {
- "description": "Human-readable description of the rule.",
- "type": "string"
- },
- "conditions": {
- "items": {
- "$ref": "GoogleIamV1__Condition"
- },
- "type": "array",
- "description": "Additional restrictions that must be met"
}
},
- "id": "GoogleIamV1__Rule"
+ "id": "GoogleIamV1__Rule",
+ "description": "A rule to be applied in a Policy.",
+ "type": "object"
},
"GoogleIamV1_LogConfig_CounterOptions": {
"description": "Increment a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
@@ -217,8 +1029,8 @@
"type": "string"
},
"metric": {
- "type": "string",
- "description": "The metric to update."
+ "description": "The metric to update.",
+ "type": "string"
}
},
"id": "GoogleIamV1_LogConfig_CounterOptions"
@@ -228,8 +1040,8 @@
"type": "object",
"properties": {
"httpBody": {
- "$ref": "GoogleApi__HttpBody",
- "description": "\nRequired. The prediction request body."
+ "description": "\nRequired. The prediction request body.",
+ "$ref": "GoogleApi__HttpBody"
}
},
"id": "GoogleCloudMlV1__PredictRequest"
@@ -239,9 +1051,9 @@
"type": "object",
"properties": {
"trainingStep": {
+ "type": "string",
"format": "int64",
- "description": "The global training step for this metric.",
- "type": "string"
+ "description": "The global training step for this metric."
},
"objectiveValue": {
"format": "double",
@@ -252,30 +1064,39 @@
"id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
},
"GoogleIamV1_LogConfig_CloudAuditOptions": {
+ "description": "Write a Cloud Audit log",
"type": "object",
"properties": {
"logName": {
- "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"
],
- "description": "The log_name to populate in the Cloud Audit Record."
+ "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\""
+ ]
}
},
- "id": "GoogleIamV1_LogConfig_CloudAuditOptions",
- "description": "Write a Cloud Audit log"
+ "id": "GoogleIamV1_LogConfig_CloudAuditOptions"
},
"GoogleCloudMlV1__Version": {
"description": "Represents a version of the model.\n\nEach version is a trained model deployed in the cloud, ready to handle\nprediction requests. A model can have multiple versions. You can get\ninformation about all of the versions of a given model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).\n\nNext ID: 18",
"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": {
+ "format": "google-datetime",
+ "description": "Output only. The time the version was last used for prediction.",
+ "type": "string"
+ },
"description": {
"description": "Optional. The description specified for the version when it was created.",
"type": "string"
@@ -289,15 +1110,20 @@
"type": "boolean"
},
"autoScaling": {
- "$ref": "GoogleCloudMlV1__AutoScaling",
- "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes."
+ "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes.",
+ "$ref": "GoogleCloudMlV1__AutoScaling"
},
"createTime": {
- "type": "string",
"format": "google-datetime",
- "description": "Output only. The time the version was created."
+ "description": "Output only. The time the version was created.",
+ "type": "string"
+ },
+ "manualScaling": {
+ "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `auto_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes.",
+ "$ref": "GoogleCloudMlV1__ManualScaling"
},
"state": {
+ "description": "Output only. The state of a version.",
"type": "string",
"enumDescriptions": [
"The version state is unspecified.",
@@ -312,51 +1138,48 @@
"CREATING",
"FAILED",
"DELETING"
- ],
- "description": "Output only. The state of a version."
- },
- "manualScaling": {
- "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `auto_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes.",
- "$ref": "GoogleCloudMlV1__ManualScaling"
+ ]
},
"name": {
- "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."
+ "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"
},
"errorMessage": {
"description": "Output only. The details of a failure or a cancellation.",
"type": "string"
- },
- "lastUseTime": {
- "format": "google-datetime",
- "description": "Output only. The time the version was last used for prediction.",
- "type": "string"
- },
- "runtimeVersion": {
- "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version.",
- "type": "string"
}
},
"id": "GoogleCloudMlV1__Version"
},
"GoogleCloudMlV1__ParameterSpec": {
+ "description": "Represents a single hyperparameter to optimize.",
"type": "object",
"properties": {
+ "parameterName": {
+ "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".",
+ "type": "string"
+ },
+ "categoricalValues": {
+ "description": "Required if type is `CATEGORICAL`. The list of possible categories.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"minValue": {
+ "type": "number",
"format": "double",
- "description": "Required if type is `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is INTEGER.",
- "type": "number"
+ "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."
},
"discreteValues": {
"description": "Required if type is `DISCRETE`.\nA list of feasible points.\nThe list should be in strictly increasing order. For instance, this\nparameter might have possible settings of 1.5, 2.5, and 4.0. This list\nshould not contain more than 1,000 values.",
"items": {
- "type": "number",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"type": "array"
},
"scaleType": {
- "type": "string",
"enumDescriptions": [
"By default, no scaling is applied.",
"Scales the feasible space to (0, 1) linearly.",
@@ -369,15 +1192,15 @@
"UNIT_LOG_SCALE",
"UNIT_REVERSE_LOG_SCALE"
],
- "description": "Optional. How the parameter should be scaled to the hypercube.\nLeave unset for categorical parameters.\nSome kind of scaling is strongly recommended for real or integral\nparameters (e.g., `UNIT_LINEAR_SCALE`)."
+ "description": "Optional. How the parameter should be scaled to the hypercube.\nLeave unset for categorical parameters.\nSome kind of scaling is strongly recommended for real or integral\nparameters (e.g., `UNIT_LINEAR_SCALE`).",
+ "type": "string"
},
"maxValue": {
- "type": "number",
"format": "double",
- "description": "Required if typeis `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is `INTEGER`."
+ "description": "Required if typeis `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is `INTEGER`.",
+ "type": "number"
},
"type": {
- "type": "string",
"enumDescriptions": [
"You must specify a valid type. Using this unspecified type will result in\nan error.",
"Type for real-valued parameters.",
@@ -392,830 +1215,16 @@
"CATEGORICAL",
"DISCRETE"
],
- "description": "Required. The type of the parameter."
- },
- "parameterName": {
- "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".",
- "type": "string"
- },
- "categoricalValues": {
- "description": "Required if type is `CATEGORICAL`. The list of possible categories.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "GoogleCloudMlV1__ParameterSpec",
- "description": "Represents a single hyperparameter to optimize."
- },
- "GoogleIamV1_LogConfig_DataAccessOptions": {
- "description": "Write a Data Access (Gin) log",
- "type": "object",
- "properties": {
- "logMode": {
- "enumDescriptions": [
- "Client is not required to write a partial Gin log immediately after\nthe authorization check. If client chooses to write one and it fails,\nclient may either fail open (allow the operation to continue) or\nfail closed (handle as a DENY outcome).",
- "The application's operation in the context of which this authorization\ncheck is being made may only be performed if it is successfully logged\nto Gin. For instance, the authorization library may satisfy this\nobligation by emitting a partial log entry at authorization check time\nand only returning ALLOW to the application if it succeeds.\n\nIf a matching Rule has this directive, but the client has not indicated\nthat it will honor such requirements, then the IAM check will result in\nauthorization failure by setting CheckPolicyResponse.success=false."
- ],
- "enum": [
- "LOG_MODE_UNSPECIFIED",
- "LOG_FAIL_CLOSED"
- ],
- "description": "Whether Gin logging should happen in a fail-closed manner at the caller.\nThis is relevant only in the LocalIAM implementation, for now.",
+ "description": "Required. The type of the parameter.",
"type": "string"
}
},
- "id": "GoogleIamV1_LogConfig_DataAccessOptions"
- },
- "GoogleCloudMlV1__PredictionInput": {
- "description": "Represents input parameters for a prediction job.",
- "type": "object",
- "properties": {
- "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"
- },
- "uri": {
- "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
- "type": "string"
- },
- "maxWorkerCount": {
- "format": "int64",
- "description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.",
- "type": "string"
- },
- "dataFormat": {
- "description": "Required. The format of the input data files.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified format.",
- "The source file is a text file with instances separated by the\nnew-line character.",
- "The source file is a TFRecord file.",
- "The source file is a GZIP-compressed TFRecord file."
- ],
- "enum": [
- "DATA_FORMAT_UNSPECIFIED",
- "TEXT",
- "TF_RECORD",
- "TF_RECORD_GZIP"
- ]
- },
- "batchSize": {
- "type": "string",
- "format": "int64",
- "description": "Optional. Number of records per batch, defaults to 64.\nThe service will buffer batch_size number of records in memory before\ninvoking one Tensorflow prediction call internally. So take the record\nsize and memory available into consideration when setting this parameter."
- },
- "runtimeVersion": {
- "description": "Optional. The Google Cloud ML runtime version to use for this batch\nprediction. If not set, Google Cloud ML will pick the runtime version used\nduring the CreateVersion request for this model version, or choose the\nlatest stable version when model version information is not available\nsuch as when the model is specified by uri.",
- "type": "string"
- },
- "inputPaths": {
- "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "region": {
- "description": "Required. The Google Compute Engine region to run the prediction job in.",
- "type": "string"
- }
- },
- "id": "GoogleCloudMlV1__PredictionInput"
- },
- "GoogleType__Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
- "properties": {
- "description": {
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "expression": {
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
- "type": "string"
- },
- "location": {
- "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
- "type": "string"
- },
- "title": {
- "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
- "type": "string"
- }
- },
- "id": "GoogleType__Expr"
- },
- "GoogleIamV1__AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "logType": {
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables."
- }
- },
- "id": "GoogleIamV1__AuditLogConfig"
- },
- "GoogleCloudMlV1__OperationMetadata": {
- "description": "Represents the metadata of the long-running operation.\n\nNext ID: 9",
- "type": "object",
- "properties": {
- "createTime": {
- "format": "google-datetime",
- "description": "The time the operation was submitted.",
- "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": {
- "format": "google-datetime",
- "description": "The time operation processing completed.",
- "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.",
- "An operation to update an existing model.",
- "An operation to update an existing version."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE_VERSION",
- "DELETE_VERSION",
- "DELETE_MODEL",
- "UPDATE_MODEL",
- "UPDATE_VERSION"
- ],
- "description": "The operation type."
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The time operation processing started.",
- "type": "string"
- },
- "isCancellationRequested": {
- "description": "Indicates whether a request to cancel this operation has been made.",
- "type": "boolean"
- }
- },
- "id": "GoogleCloudMlV1__OperationMetadata"
- },
- "GoogleCloudMlV1__HyperparameterSpec": {
- "description": "Represents a set of hyperparameters to optimize.",
- "type": "object",
- "properties": {
- "maxParallelTrials": {
- "format": "int32",
- "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.",
- "type": "integer"
- },
- "hyperparameterMetricTag": {
- "type": "string",
- "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."
- },
- "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"
- },
- "maxTrials": {
- "format": "int32",
- "description": "Optional. How many training trials should be attempted to optimize\nthe specified hyperparameters.\n\nDefaults to one.",
- "type": "integer"
- },
- "params": {
- "description": "Required. The set of parameters to tune.",
- "items": {
- "$ref": "GoogleCloudMlV1__ParameterSpec"
- },
- "type": "array"
- }
- },
- "id": "GoogleCloudMlV1__HyperparameterSpec"
- },
- "GoogleCloudMlV1__ListJobsResponse": {
- "id": "GoogleCloudMlV1__ListJobsResponse",
- "description": "Response message for the ListJobs method.",
- "type": "object",
- "properties": {
- "jobs": {
- "description": "The list of jobs.",
- "items": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
- }
- }
- },
- "GoogleCloudMlV1__SetDefaultVersionRequest": {
- "id": "GoogleCloudMlV1__SetDefaultVersionRequest",
- "description": "Request message for the SetDefaultVersion request.",
- "type": "object",
- "properties": {}
- },
- "GoogleLongrunning__Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "GoogleRpc__Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- }
- },
- "id": "GoogleLongrunning__Operation"
- },
- "GoogleIamV1__AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "items": {
- "$ref": "GoogleIamV1__AuditLogConfig"
- },
- "type": "array",
- "description": "The configuration for logging of each type of permission.\nNext ID: 4"
- },
- "exemptedMembers": {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "GoogleIamV1__AuditConfig"
- },
- "GoogleCloudMlV1__Model": {
- "properties": {
- "regions": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "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."
- },
- "name": {
- "description": "Required. The name specified for the model when it was created.\n\nThe model name must be unique within the project it is created in.",
- "type": "string"
- },
- "description": {
- "description": "Optional. The description specified for the model when it was created.",
- "type": "string"
- },
- "onlinePredictionLogging": {
- "description": "Optional. If true, enables StackDriver Logging for online prediction.\nDefault is false.",
- "type": "boolean"
- },
- "defaultVersion": {
- "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
- "$ref": "GoogleCloudMlV1__Version"
- }
- },
- "id": "GoogleCloudMlV1__Model",
- "description": "Represents a machine learning solution.\n\nA model can have multiple versions, each of which is a deployed, trained\nmodel ready to receive prediction requests. The model itself is just a\ncontainer.\n\nNext ID: 8",
- "type": "object"
- },
- "GoogleProtobuf__Empty": {
- "type": "object",
- "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 `{}`."
- },
- "GoogleCloudMlV1__ListVersionsResponse": {
- "description": "Response message for the ListVersions method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
- },
- "versions": {
- "description": "The list of versions.",
- "items": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "type": "array"
- }
- },
- "id": "GoogleCloudMlV1__ListVersionsResponse"
- },
- "GoogleCloudMlV1__CancelJobRequest": {
- "description": "Request message for the CancelJob method.",
- "type": "object",
- "properties": {},
- "id": "GoogleCloudMlV1__CancelJobRequest"
- },
- "GoogleIamV1__TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "GoogleIamV1__TestIamPermissionsRequest"
- },
- "GoogleIamV1__LogConfig": {
- "description": "Specifies what kind of log the caller must write",
- "type": "object",
- "properties": {
- "counter": {
- "description": "Counter options.",
- "$ref": "GoogleIamV1_LogConfig_CounterOptions"
- },
- "dataAccess": {
- "$ref": "GoogleIamV1_LogConfig_DataAccessOptions",
- "description": "Data access options."
- },
- "cloudAudit": {
- "description": "Cloud audit options.",
- "$ref": "GoogleIamV1_LogConfig_CloudAuditOptions"
- }
- },
- "id": "GoogleIamV1__LogConfig"
- },
- "GoogleCloudMlV1__AutoScaling": {
- "description": "Options for automatically scaling a model.",
- "type": "object",
- "properties": {
- "minNodes": {
- "format": "int32",
- "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.",
- "type": "integer"
- }
- },
- "id": "GoogleCloudMlV1__AutoScaling"
- },
- "GoogleRpc__Status": {
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "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."
- },
- "GoogleCloudMlV1__ListModelsResponse": {
- "id": "GoogleCloudMlV1__ListModelsResponse",
- "description": "Response message for the ListModels method.",
- "type": "object",
- "properties": {
- "models": {
- "description": "The list of models.",
- "items": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
- }
- }
- },
- "GoogleCloudMlV1__TrainingInput": {
- "id": "GoogleCloudMlV1__TrainingInput",
- "description": "Represents input parameters for a training job.",
- "type": "object",
- "properties": {
- "runtimeVersion": {
- "description": "Optional. The Google Cloud ML runtime version to use for training. If not\nset, Google Cloud ML will choose the latest stable version.",
- "type": "string"
- },
- "pythonModule": {
- "description": "Required. The Python module name to run after installing the packages.",
- "type": "string"
- },
- "region": {
- "description": "Required. The Google Compute Engine region to run the training job in.",
- "type": "string"
- },
- "workerType": {
- "description": "Optional. Specifies the type of virtual machine to use for your training\njob's worker nodes.\n\nThe supported values are the same as those described in the entry for\n`masterType`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`workerCount` is greater than zero.",
- "type": "string"
- },
- "args": {
- "description": "Optional. Command line arguments to pass to the program.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "parameterServerType": {
- "description": "Optional. Specifies the type of virtual machine to use for your training\njob's parameter server.\n\nThe supported values are the same as those described in the entry for\n`master_type`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`parameter_server_count` is greater than zero.",
- "type": "string"
- },
- "scaleTier": {
- "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\nGPU](/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",
- "PREMIUM_1",
- "BASIC_GPU",
- "CUSTOM"
- ],
- "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers."
- },
- "jobDir": {
- "description": "Optional. A Google Cloud Storage path in which to store training outputs\nand other data needed for training. This path is passed to your TensorFlow\nprogram as the 'job_dir' command-line argument. The benefit of specifying\nthis field is that Cloud ML validates the path for use in training.",
- "type": "string"
- },
- "hyperparameters": {
- "$ref": "GoogleCloudMlV1__HyperparameterSpec",
- "description": "Optional. The set of Hyperparameters to tune."
- },
- "parameterServerCount": {
- "format": "int64",
- "description": "Optional. The number of parameter server replicas to use for the training\njob. Each replica in the cluster will be of the type specified in\n`parameter_server_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`.If you\nset this value, you must also set `parameter_server_type`.",
- "type": "string"
- },
- "packageUris": {
- "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.\nThe maximum number of package URIs is 100.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "workerCount": {
- "format": "int64",
- "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.",
- "type": "string"
- },
- "masterType": {
- "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a\n \u003ca href=\"/ml-engine/docs/how-tos/using-gpus\"\u003e\n GPU that you can use in your trainer\u003c/a\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four GPUs.\n \u003c/dd\u003e\n\u003c/dl\u003e\n\nYou must set this value when `scaleTier` is set to `CUSTOM`.",
- "type": "string"
- }
- }
- },
- "GoogleCloudMlV1__Job": {
- "description": "Represents a training or prediction job.\n\nNext ID: 16",
- "type": "object",
- "properties": {
- "trainingOutput": {
- "description": "The current training job result.",
- "$ref": "GoogleCloudMlV1__TrainingOutput"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Output only. When the job was created.",
- "type": "string"
- },
- "trainingInput": {
- "$ref": "GoogleCloudMlV1__TrainingInput",
- "description": "Input parameters to create a training 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"
- },
- "predictionInput": {
- "$ref": "GoogleCloudMlV1__PredictionInput",
- "description": "Input parameters to create a prediction job."
- },
- "jobId": {
- "description": "Required. The user-specified id of the job.",
- "type": "string"
- },
- "errorMessage": {
- "description": "Output only. The details of a failure or a cancellation.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Output only. When the job processing was completed.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Output only. When the job processing was started.",
- "type": "string"
- },
- "predictionOutput": {
- "$ref": "GoogleCloudMlV1__PredictionOutput",
- "description": "The current prediction job result."
- }
- },
- "id": "GoogleCloudMlV1__Job"
- },
- "GoogleApi__HttpBody": {
- "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.",
- "type": "object",
- "properties": {
- "extensions": {
- "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- },
- "data": {
- "format": "byte",
- "description": "HTTP body binary data.",
- "type": "string"
- },
- "contentType": {
- "description": "The HTTP Content-Type string representing the content type of the body.",
- "type": "string"
- }
- },
- "id": "GoogleApi__HttpBody"
- },
- "GoogleCloudMlV1__GetConfigResponse": {
- "id": "GoogleCloudMlV1__GetConfigResponse",
- "description": "Returns service account information associated with a project.",
- "type": "object",
- "properties": {
- "serviceAccountProject": {
- "format": "int64",
- "description": "The project number for `service_account`.",
- "type": "string"
- },
- "serviceAccount": {
- "description": "The service account Cloud ML uses to access resources in the project.",
- "type": "string"
- }
- }
- },
- "GoogleIamV1__TestIamPermissionsResponse": {
- "type": "object",
- "properties": {
- "permissions": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
- }
- },
- "id": "GoogleIamV1__TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method."
- },
- "GoogleIamV1__SetIamPolicyRequest": {
- "properties": {
- "policy": {
- "$ref": "GoogleIamV1__Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "type": "string"
- }
- },
- "id": "GoogleIamV1__SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
- },
- "GoogleCloudMlV1__HyperparameterOutput": {
- "id": "GoogleCloudMlV1__HyperparameterOutput",
- "description": "Represents the result of a single hyperparameter tuning trial from a\ntraining job. The TrainingOutput object that is returned on successful\ncompletion of a training job with hyperparameter tuning includes a list\nof HyperparameterOutput objects, one for each successful trial.",
- "type": "object",
- "properties": {
- "allMetrics": {
- "description": "All recorded object metrics for this trial.",
- "items": {
- "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
- },
- "type": "array"
- },
- "finalMetric": {
- "description": "The final objective metric seen for this trial.",
- "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
- },
- "hyperparameters": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The hyperparameters given to this trial.",
- "type": "object"
- },
- "trialId": {
- "description": "The trial id for these results.",
- "type": "string"
- }
- }
- },
- "GoogleCloudMlV1__PredictionOutput": {
- "description": "Represents results of a prediction job.",
- "type": "object",
- "properties": {
- "errorCount": {
- "format": "int64",
- "description": "The number of data instances which resulted in errors.",
- "type": "string"
- },
- "nodeHours": {
- "format": "double",
- "description": "Node hours used by the batch prediction job.",
- "type": "number"
- },
- "outputPath": {
- "description": "The output Google Cloud Storage location provided at the job creation time.",
- "type": "string"
- },
- "predictionCount": {
- "format": "int64",
- "description": "The number of generated predictions.",
- "type": "string"
- }
- },
- "id": "GoogleCloudMlV1__PredictionOutput"
- },
- "GoogleIamV1__Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "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.",
- "items": {
- "$ref": "GoogleIamV1__Rule"
- },
- "type": "array"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "items": {
- "$ref": "GoogleIamV1__AuditConfig"
- },
- "type": "array"
- },
- "bindings": {
- "items": {
- "$ref": "GoogleIamV1__Binding"
- },
- "type": "array",
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error."
- },
- "etag": {
- "format": "byte",
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "type": "string"
- }
- },
- "id": "GoogleIamV1__Policy"
- },
- "GoogleLongrunning__ListOperationsResponse": {
- "id": "GoogleLongrunning__ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "operations": {
- "items": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "type": "array",
- "description": "A list of operations that matches the specified filter in the request."
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- }
+ "id": "GoogleCloudMlV1__ParameterSpec"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Cloud Machine Learning Engine",
@@ -1236,101 +1245,20 @@
"ownerName": "Google",
"resources": {
"projects": {
- "methods": {
- "getConfig": {
- "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__GetConfigResponse"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The project name.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}:getConfig",
- "path": "v1/{+name}:getConfig",
- "id": "ml.projects.getConfig"
- },
- "predict": {
- "request": {
- "$ref": "GoogleCloudMlV1__PredictRequest"
- },
- "description": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION",
- "response": {
- "$ref": "GoogleApi__HttpBody"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires the `predict` permission on the specified resource.",
- "type": "string",
- "required": true,
- "pattern": "^projects/.+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}:predict",
- "id": "ml.projects.predict",
- "path": "v1/{+name}:predict"
- }
- },
"resources": {
"models": {
"methods": {
- "getIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:getIamPolicy",
- "id": "ml.projects.models.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$"
- }
- }
- },
"get": {
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
- "id": "ml.projects.models.get",
"path": "v1/{+name}",
+ "id": "ml.projects.models.get",
"description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed).",
- "response": {
- "$ref": "GoogleCloudMlV1__Model"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -1342,62 +1270,86 @@
"pattern": "^projects/[^/]+/models/[^/]+$",
"location": "path"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}"
},
"testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "ml.projects.models.testIamPermissions",
"request": {
"$ref": "GoogleIamV1__TestIamPermissionsRequest"
},
- "response": {
- "$ref": "GoogleIamV1__TestIamPermissionsResponse"
- },
+ "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"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "GoogleIamV1__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.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$"
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete).",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions",
- "id": "ml.projects.models.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.delete"
},
- "delete": {
- "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete).",
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
+ "list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "name": {
+ "parent": {
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$",
+ "pattern": "^projects/[^/]+$",
"location": "path",
- "description": "Required. The name of the model."
+ "description": "Required. The name of the project whose models are to be listed."
+ },
+ "pageToken": {
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "type": "integer",
+ "location": "query"
}
},
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
- "id": "ml.projects.models.delete",
- "path": "v1/{+name}"
- },
- "list": {
"flatPath": "v1/projects/{projectsId}/models",
"path": "v1/{+parent}/models",
"id": "ml.projects.models.list",
@@ -1408,29 +1360,6 @@
],
"response": {
"$ref": "GoogleCloudMlV1__ListModelsResponse"
- },
- "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": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100."
- },
- "parent": {
- "description": "Required. The name of the project whose models are to be listed.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
}
},
"setIamPolicy": {
@@ -1438,66 +1367,152 @@
"$ref": "GoogleIamV1__SetIamPolicyRequest"
},
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "ml.projects.models.setIamPolicy"
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/models",
+ "id": "ml.projects.models.create",
+ "path": "v1/{+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/v1/projects.models.versions/create).",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "response": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project name."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "getIamPolicy": {
"response": {
"$ref": "GoogleIamV1__Policy"
},
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
}
},
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:setIamPolicy",
- "id": "ml.projects.models.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
- },
- "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).",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The project name.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models",
- "path": "v1/{+parent}/models",
- "id": "ml.projects.models.create"
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}:getIamPolicy",
+ "id": "ml.projects.models.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
}
},
"resources": {
"versions": {
"methods": {
+ "get": {
+ "id": "ml.projects.models.versions.get",
+ "path": "v1/{+name}",
+ "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the version.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}"
+ },
+ "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": {
+ "format": "int32",
+ "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model for which to list the version.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "id": "ml.projects.models.versions.list",
+ "path": "v1/{+parent}/versions"
+ },
"create": {
+ "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
"request": {
"$ref": "GoogleCloudMlV1__Version"
},
- "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
"response": {
"$ref": "GoogleLongrunning__Operation"
},
@@ -1505,27 +1520,23 @@
"parent"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"parent": {
+ "location": "path",
"description": "Required. The name of the model.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/models/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
"id": "ml.projects.models.versions.create",
"path": "v1/{+parent}/versions"
},
"setDefault": {
- "request": {
- "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
- },
- "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method.",
"httpMethod": "POST",
"parameterOrder": [
"name"
@@ -1533,23 +1544,30 @@
"response": {
"$ref": "GoogleCloudMlV1__Version"
},
+ "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).",
+ "type": "string",
+ "required": true
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path",
- "description": "Required. The name of the version 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)."
- }
- },
"flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
"path": "v1/{+name}:setDefault",
- "id": "ml.projects.models.versions.setDefault"
+ "id": "ml.projects.models.versions.setDefault",
+ "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
+ }
},
"delete": {
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "id": "ml.projects.models.versions.delete",
+ "path": "v1/{+name}",
"description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.",
"response": {
"$ref": "GoogleLongrunning__Operation"
@@ -1569,70 +1587,6 @@
"pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
"location": "path"
}
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "id": "ml.projects.models.versions.delete",
- "path": "v1/{+name}"
- },
- "get": {
- "response": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the version.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "id": "ml.projects.models.versions.get",
- "path": "v1/{+name}",
- "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model."
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
- "id": "ml.projects.models.versions.list",
- "path": "v1/{+parent}/versions",
- "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has a lot of versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages):",
- "response": {
- "$ref": "GoogleCloudMlV1__ListVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model for which to list the version.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "type": "integer",
- "location": "query"
- }
}
}
}
@@ -1641,43 +1595,18 @@
},
"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",
+ "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"
],
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "GET",
"parameters": {
"name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/operations/[^/]+$"
- }
- },
- "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"
- },
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
+ "description": "The name of the operation resource.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/operations/[^/]+$",
@@ -1688,22 +1617,80 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "id": "ml.projects.operations.delete",
+ "id": "ml.projects.operations.get",
"path": "v1/{+name}"
},
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "GoogleLongrunning__ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
"httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation's parent resource."
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations",
+ "id": "ml.projects.operations.list",
+ "path": "v1/{+name}/operations"
+ },
+ "cancel": {
+ "path": "v1/{+name}:cancel",
+ "id": "ml.projects.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
- "$ref": "GoogleLongrunning__Operation"
+ "$ref": "GoogleProtobuf__Empty"
},
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
"location": "path",
- "description": "The name of the operation resource.",
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel"
+ },
+ "delete": {
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/operations/[^/]+$"
@@ -1713,62 +1700,136 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ "id": "ml.projects.operations.delete",
"path": "v1/{+name}",
- "id": "ml.projects.operations.get"
- },
- "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",
+ "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": "GoogleLongrunning__ListOperationsResponse"
+ "$ref": "GoogleProtobuf__Empty"
},
"parameterOrder": [
"name"
],
- "parameters": {
- "filter": {
- "type": "string",
- "location": "query",
- "description": "The standard list filter."
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/operations",
- "path": "v1/{+name}/operations",
- "id": "ml.projects.operations.list"
+ "httpMethod": "DELETE"
}
}
},
"jobs": {
"methods": {
- "list": {
+ "cancel": {
+ "request": {
+ "$ref": "GoogleCloudMlV1__CancelJobRequest"
+ },
+ "description": "Cancels a running job.",
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the job to cancel.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
+ "id": "ml.projects.jobs.cancel",
+ "path": "v1/{+name}:cancel"
+ },
+ "getIamPolicy": {
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy",
+ "id": "ml.projects.jobs.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET"
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "ml.projects.jobs.get",
+ "description": "Describes a job.",
"httpMethod": "GET",
"response": {
- "$ref": "GoogleCloudMlV1__ListJobsResponse"
+ "$ref": "GoogleCloudMlV1__Job"
},
"parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the job to get the description of.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/jobs/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}"
+ },
+ "testIamPermissions": {
+ "id": "ml.projects.jobs.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "GoogleIamV1__TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "GoogleIamV1__TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions"
+ },
+ "list": {
+ "description": "Lists the jobs in the project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
"parent"
],
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListJobsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -1799,23 +1860,48 @@
},
"flatPath": "v1/projects/{projectsId}/jobs",
"path": "v1/{+parent}/jobs",
- "id": "ml.projects.jobs.list",
- "description": "Lists the jobs in the project."
+ "id": "ml.projects.jobs.list"
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/jobs",
+ "id": "ml.projects.jobs.create",
+ "path": "v1/{+parent}/jobs",
+ "description": "Creates a training or a batch prediction job.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"setIamPolicy": {
- "id": "ml.projects.jobs.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "GoogleIamV1__SetIamPolicyRequest"
},
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -1828,209 +1914,91 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy"
- },
- "create": {
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The project name.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs",
- "id": "ml.projects.jobs.create",
- "path": "v1/{+parent}/jobs",
- "request": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "description": "Creates a training or a batch prediction job."
- },
- "cancel": {
- "description": "Cancels a running job.",
- "request": {
- "$ref": "GoogleCloudMlV1__CancelJobRequest"
- },
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The name of the job to cancel.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/jobs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
- "id": "ml.projects.jobs.cancel",
- "path": "v1/{+name}:cancel"
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "ml.projects.jobs.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "description": "Describes a job.",
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the job to get the description of.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.jobs.get"
- },
- "testIamPermissions": {
- "response": {
- "$ref": "GoogleIamV1__TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions",
- "id": "ml.projects.jobs.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": "GoogleIamV1__TestIamPermissionsRequest"
- }
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "ml.projects.jobs.setIamPolicy"
}
}
}
+ },
+ "methods": {
+ "getConfig": {
+ "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__GetConfigResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The project name.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:getConfig",
+ "id": "ml.projects.getConfig",
+ "path": "v1/{+name}:getConfig"
+ },
+ "predict": {
+ "response": {
+ "$ref": "GoogleApi__HttpBody"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires the `predict` permission on the specified resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/.+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:predict",
+ "id": "ml.projects.predict",
+ "path": "v1/{+name}:predict",
+ "request": {
+ "$ref": "GoogleCloudMlV1__PredictRequest"
+ },
+ "description": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION"
+ }
}
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "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": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
]
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
+ "default": "json",
"enum": [
"json",
"media",
@@ -2043,27 +2011,59 @@
"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": {
"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.",
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
}
- },
- "version": "v1",
- "baseUrl": "https://ml.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "An API to enable creating and using machine learning models.",
- "servicePath": "",
- "basePath": "",
- "revision": "20170819",
- "documentationLink": "https://cloud.google.com/ml/",
- "id": "ml:v1"
+ }
}
diff --git a/monitoring/v3/monitoring-api.json b/monitoring/v3/monitoring-api.json
index 7b8a622..ad36710 100644
--- a/monitoring/v3/monitoring-api.json
+++ b/monitoring/v3/monitoring-api.json
@@ -1,762 +1,276 @@
{
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "timeSeries": {
- "methods": {
- "list": {
- "path": "v3/{+name}/timeSeries",
- "id": "monitoring.projects.timeSeries.list",
- "description": "Lists time series that match a filter. This method does not require a Stackdriver account.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListTimeSeriesResponse"
- },
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
- "type": "integer",
- "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": {
- "format": "google-datetime",
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "type": "string",
- "location": "query"
- },
- "view": {
- "type": "string",
- "location": "query",
- "enum": [
- "FULL",
- "HEADERS"
- ],
- "description": "Specifies which information is returned about the time series."
- },
- "name": {
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- },
- "aggregation.groupByFields": {
- "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "interval.endTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "Required. The end of the time interval.",
- "type": "string"
- },
- "aggregation.alignmentPeriod": {
- "location": "query",
- "format": "google-duration",
- "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
- "type": "string"
- }
- },
- "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"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/timeSeries",
- "path": "v3/{+name}/timeSeries",
- "id": "monitoring.projects.timeSeries.create",
- "description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.",
- "request": {
- "$ref": "CreateTimeSeriesRequest"
- }
- }
- }
- },
- "metricDescriptors": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metricDescriptors/.+$",
- "location": "path",
- "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\"."
- }
- },
- "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}",
- "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted."
- },
- "get": {
- "id": "monitoring.projects.metricDescriptors.get",
- "path": "v3/{+name}",
- "description": "Gets a single metric descriptor. This method does not require a Stackdriver account.",
- "response": {
- "$ref": "MetricDescriptor"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metricDescriptors/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}"
- },
- "list": {
- "id": "monitoring.projects.metricDescriptors.list",
- "path": "v3/{+name}/metricDescriptors",
- "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.",
- "response": {
- "$ref": "ListMetricDescriptorsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\"."
- },
- "pageSize": {
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/metricDescriptors"
- },
- "create": {
- "request": {
- "$ref": "MetricDescriptor"
- },
- "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.",
- "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": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v3/projects/{projectsId}/metricDescriptors",
- "path": "v3/{+name}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.create"
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "get": {
- "response": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$",
- "location": "path",
- "description": "The monitored resource descriptor to get. The format is \"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}\". The {resource_type} is a predefined type, such as cloudsql_database.",
- "type": "string",
- "required": true
- }
- },
- "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."
- },
- "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"
- },
- "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"
- },
- "pageToken": {
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return.",
- "type": "integer"
- }
- },
- "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors",
- "path": "v3/{+name}/monitoredResourceDescriptors",
- "id": "monitoring.projects.monitoredResourceDescriptors.list"
- }
- }
- },
- "groups": {
- "resources": {
- "members": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListGroupMembersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "interval.endTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "Required. The end of the time interval.",
- "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",
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return.",
- "type": "integer"
- },
- "interval.startTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "type": "string"
- },
- "name": {
- "location": "path",
- "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/groups/[^/]+$"
- }
- },
- "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."
- }
- }
- }
- },
- "methods": {
- "delete": {
- "description": "Deletes an existing group.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path",
- "description": "The group to delete. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.delete"
- },
- "get": {
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Group"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "name": {
- "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "id": "monitoring.projects.groups.get",
- "path": "v3/{+name}",
- "description": "Gets a single group."
- },
- "list": {
- "response": {
- "$ref": "ListGroupsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "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": {
- "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",
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return.",
- "type": "integer"
- },
- "ancestorsOfGroup": {
- "location": "query",
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true
- },
- "childrenOfGroup": {
- "location": "query",
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.",
- "type": "string"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups",
- "id": "monitoring.projects.groups.list",
- "path": "v3/{+name}/groups",
- "description": "Lists the existing groups."
- },
- "update": {
- "request": {
- "$ref": "Group"
- },
- "description": "Updates an existing group. You can change any group attributes except name.",
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "parameters": {
- "validateOnly": {
- "description": "If true, validate this request but do not update the existing group.",
- "type": "boolean",
- "location": "query"
- },
- "name": {
- "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "id": "monitoring.projects.groups.update",
- "path": "v3/{+name}"
- },
- "create": {
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "parameters": {
- "validateOnly": {
- "location": "query",
- "description": "If true, validate this request but do not create the group.",
- "type": "boolean"
- },
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups",
- "id": "monitoring.projects.groups.create",
- "path": "v3/{+name}/groups",
- "request": {
- "$ref": "Group"
- },
- "description": "Creates a new group."
- }
- }
- },
- "collectdTimeSeries": {
- "methods": {
- "create": {
- "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",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "name": {
- "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v3/projects/{projectsId}/collectdTimeSeries"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "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.",
- "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": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- }
- },
- "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": "",
- "revision": "20170820",
+ "revision": "20170822",
"documentationLink": "https://cloud.google.com/monitoring/api/",
"id": "monitoring:v3",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Exponential": {
+ "TimeSeries": {
"properties": {
- "growthFactor": {
+ "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": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ],
+ "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.",
+ "type": "string"
+ },
+ "points": {
+ "description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
+ "items": {
+ "$ref": "Point"
+ },
+ "type": "array"
+ },
+ "metric": {
+ "description": "The associated metric. A fully-specified metric used to identify the time series.",
+ "$ref": "Metric"
+ }
+ },
+ "id": "TimeSeries",
+ "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.",
+ "type": "object"
+ },
+ "CreateTimeSeriesRequest": {
+ "properties": {
+ "timeSeries": {
+ "description": "The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.",
+ "items": {
+ "$ref": "TimeSeries"
+ },
+ "type": "array"
+ }
+ },
+ "id": "CreateTimeSeriesRequest",
+ "description": "The CreateTimeSeries request.",
+ "type": "object"
+ },
+ "Distribution": {
+ "properties": {
+ "sumOfSquaredDeviation": {
"format": "double",
- "description": "Must be greater than 1.",
+ "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.",
"type": "number"
},
- "scale": {
- "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": {
+ "format": "int64",
+ "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.",
+ "type": "string"
+ },
+ "mean": {
"format": "double",
- "description": "Must be greater than 0."
+ "description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
+ "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.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "bucketOptions": {
+ "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.",
+ "$ref": "BucketOptions"
+ }
+ },
+ "id": "Distribution",
+ "description": "Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.",
+ "type": "object"
+ },
+ "MonitoredResource": {
+ "properties": {
+ "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",
+ "type": "object"
+ },
+ "ListMetricDescriptorsResponse": {
+ "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"
+ },
+ "metricDescriptors": {
+ "description": "The metric descriptors that are available to the project and that match the value of filter, if present.",
+ "items": {
+ "$ref": "MetricDescriptor"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListMetricDescriptorsResponse",
+ "description": "The ListMetricDescriptors response.",
+ "type": "object"
+ },
+ "MonitoredResourceDescriptor": {
+ "properties": {
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
+ "type": "string"
+ }
+ },
+ "id": "MonitoredResourceDescriptor",
+ "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
+ "type": "object"
+ },
+ "TypedValue": {
+ "description": "A single strongly-typed value.",
+ "type": "object",
+ "properties": {
+ "doubleValue": {
+ "format": "double",
+ "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10\u003csup\u003e±300\u003c/sup\u003e and it has 16 significant digits of precision.",
+ "type": "number"
+ },
+ "int64Value": {
+ "format": "int64",
+ "description": "A 64-bit integer. Its range is approximately ±9.2x10\u003csup\u003e18\u003c/sup\u003e.",
+ "type": "string"
+ },
+ "distributionValue": {
+ "description": "A distribution value.",
+ "$ref": "Distribution"
+ },
+ "stringValue": {
+ "description": "A variable-length string value.",
+ "type": "string"
+ },
+ "boolValue": {
+ "description": "A Boolean value: true or false.",
+ "type": "boolean"
+ }
+ },
+ "id": "TypedValue"
+ },
+ "CollectdPayload": {
+ "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
+ "type": "object",
+ "properties": {
+ "typeInstance": {
+ "description": "The measurement type instance. Example: \"used\".",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "$ref": "TypedValue"
+ },
+ "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345",
+ "type": "object"
+ },
+ "type": {
+ "description": "The measurement type. Example: \"memory\".",
+ "type": "string"
+ },
+ "plugin": {
+ "description": "The name of the plugin. Example: \"disk\".",
+ "type": "string"
+ },
+ "pluginInstance": {
+ "description": "The instance name of the plugin Example: \"hdcl\".",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The end time of the interval.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start time of the interval.",
+ "type": "string"
+ },
+ "values": {
+ "description": "The measured values during this time interval. Each value must have a different dataSourceName.",
+ "items": {
+ "$ref": "CollectdValue"
+ },
+ "type": "array"
+ }
+ },
+ "id": "CollectdPayload"
+ },
+ "Linear": {
+ "properties": {
+ "width": {
+ "format": "double",
+ "description": "Must be greater than 0.",
+ "type": "number"
+ },
+ "offset": {
+ "format": "double",
+ "description": "Lower bound of the first bucket.",
+ "type": "number"
},
"numFiniteBuckets": {
"format": "int32",
@@ -764,55 +278,140 @@
"type": "integer"
}
},
+ "id": "Linear",
+ "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
+ "type": "object"
+ },
+ "Option": {
+ "properties": {
+ "value": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".",
+ "type": "string"
+ }
+ },
+ "id": "Option",
+ "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
+ "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"
+ },
+ "Explicit": {
+ "properties": {
+ "bounds": {
+ "description": "The values must be monotonically increasing.",
+ "items": {
+ "format": "double",
+ "type": "number"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Explicit",
+ "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
+ "type": "object"
+ },
+ "TimeInterval": {
+ "description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.",
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Required. The end of the time interval.",
+ "type": "string"
+ }
+ },
+ "id": "TimeInterval"
+ },
+ "Exponential": {
+ "properties": {
+ "scale": {
+ "format": "double",
+ "description": "Must be greater than 0.",
+ "type": "number"
+ },
+ "numFiniteBuckets": {
+ "format": "int32",
+ "description": "Must be greater than 0.",
+ "type": "integer"
+ },
+ "growthFactor": {
+ "format": "double",
+ "description": "Must be greater than 1.",
+ "type": "number"
+ }
+ },
"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"
},
"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."
+ "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"
+ "$ref": "TypedValue",
+ "description": "The value of the data point."
}
},
- "id": "Point",
- "description": "A single data point in a time series."
+ "id": "Point"
+ },
+ "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"
},
"Field": {
"description": "A single field of a message type.",
"type": "object",
"properties": {
+ "typeUrl": {
+ "description": "The field type URL, without the scheme, for message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Timestamp\".",
+ "type": "string"
+ },
+ "number": {
+ "format": "int32",
+ "description": "The field number.",
+ "type": "integer"
+ },
"jsonName": {
- "type": "string",
- "description": "The field JSON name."
+ "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",
@@ -835,7 +434,28 @@
"TYPE_SINT64"
],
"description": "The field type.",
- "type": "string"
+ "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.",
@@ -876,37 +496,10 @@
"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": {
- "format": "int32",
- "description": "The field number.",
- "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": {
"properties": {
"valueType": {
@@ -924,8 +517,8 @@
"type": "string"
},
"key": {
- "type": "string",
- "description": "The label key."
+ "description": "The label key.",
+ "type": "string"
},
"description": {
"description": "A human-readable description for the label.",
@@ -938,29 +531,77 @@
},
"ListTimeSeriesResponse": {
"properties": {
+ "nextPageToken": {
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
+ "type": "string"
+ },
"timeSeries": {
"description": "One or more time series that match the filter included in the request.",
"items": {
"$ref": "TimeSeries"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
- "type": "string"
}
},
"id": "ListTimeSeriesResponse",
"description": "The ListTimeSeries response.",
"type": "object"
},
+ "Type": {
+ "properties": {
+ "fields": {
+ "description": "The list of fields.",
+ "items": {
+ "$ref": "Field"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The fully qualified message name.",
+ "type": "string"
+ },
+ "oneofs": {
+ "description": "The list of types appearing in oneof definitions in this type.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax proto2.",
+ "Syntax proto3."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax.",
+ "type": "string"
+ },
+ "options": {
+ "description": "The protocol buffer options.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Type",
+ "description": "A protocol buffer message type.",
+ "type": "object"
+ },
"Group": {
"description": "The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: \"environment\" and \"role\". A parent group has a filter, environment=\"production\". A child of that parent group has a filter, role=\"transcoder\". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.",
"type": "object",
"properties": {
"filter": {
- "type": "string",
- "description": "The filter used to determine which monitored resources belong to this group."
+ "description": "The filter used to determine which monitored resources belong to this group.",
+ "type": "string"
},
"parentName": {
"description": "The name of the group's parent, if it has one. The format is \"projects/{project_id_or_number}/groups/{group_id}\". For groups with no parent, parentName is the empty string, \"\".",
@@ -981,90 +622,36 @@
},
"id": "Group"
},
- "Type": {
- "description": "A protocol buffer message type.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The list of fields.",
- "items": {
- "$ref": "Field"
- },
- "type": "array"
- },
- "name": {
- "description": "The fully qualified message name.",
- "type": "string"
- },
- "oneofs": {
- "description": "The list of types appearing in oneof definitions in this type.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "syntax": {
- "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.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
- }
- },
- "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": {
"exponentialBuckets": {
- "$ref": "Exponential",
- "description": "The exponential buckets."
+ "description": "The exponential buckets.",
+ "$ref": "Exponential"
},
"explicitBuckets": {
- "$ref": "Explicit",
- "description": "The explicit buckets."
+ "description": "The explicit buckets.",
+ "$ref": "Explicit"
},
"linearBuckets": {
- "$ref": "Linear",
- "description": "The linear bucket."
+ "description": "The linear bucket.",
+ "$ref": "Linear"
}
},
- "id": "BucketOptions"
+ "id": "BucketOptions",
+ "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
+ "type": "object"
},
"CollectdValue": {
- "description": "A single data point from a collectd-based plugin.",
- "type": "object",
"properties": {
+ "dataSourceName": {
+ "description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".",
+ "type": "string"
+ },
"value": {
- "$ref": "TypedValue",
- "description": "The measurement value."
+ "description": "The measurement value.",
+ "$ref": "TypedValue"
},
"dataSourceType": {
- "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",
@@ -1072,14 +659,31 @@
"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\".",
+ "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."
+ ]
+ }
+ },
+ "id": "CollectdValue",
+ "description": "A single data point from a collectd-based plugin.",
+ "type": "object"
+ },
+ "SourceContext": {
+ "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".",
"type": "string"
}
},
- "id": "CollectdValue"
+ "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.",
@@ -1090,11 +694,11 @@
"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.",
"items": {
"$ref": "LabelDescriptor"
},
- "type": "array",
- "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"
},
"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",
@@ -1105,8 +709,6 @@
"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.",
@@ -1124,11 +726,11 @@
"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.",
@@ -1140,7 +742,9 @@
"GAUGE",
"DELTA",
"CUMULATIVE"
- ]
+ ],
+ "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string"
},
"description": {
"description": "A detailed description of the metric, which can be used in documentation.",
@@ -1153,17 +757,6 @@
},
"id": "MetricDescriptor"
},
- "SourceContext": {
- "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",
- "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
- "type": "object"
- },
"Range": {
"description": "The range of the population values.",
"type": "object",
@@ -1199,10 +792,30 @@
},
"id": "ListGroupsResponse"
},
- "ListGroupMembersResponse": {
- "description": "The ListGroupMembers response.",
+ "CreateCollectdTimeSeriesRequest": {
+ "description": "The CreateCollectdTimeSeries request.",
"type": "object",
"properties": {
+ "collectdPayloads": {
+ "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
+ "items": {
+ "$ref": "CollectdPayload"
+ },
+ "type": "array"
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "The monitored resource associated with the time series."
+ },
+ "collectdVersion": {
+ "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
+ "type": "string"
+ }
+ },
+ "id": "CreateCollectdTimeSeriesRequest"
+ },
+ "ListGroupMembersResponse": {
+ "properties": {
"members": {
"description": "A set of monitored resources in the group.",
"items": {
@@ -1220,29 +833,9 @@
"type": "integer"
}
},
- "id": "ListGroupMembersResponse"
- },
- "CreateCollectdTimeSeriesRequest": {
- "id": "CreateCollectdTimeSeriesRequest",
- "description": "The CreateCollectdTimeSeries request.",
- "type": "object",
- "properties": {
- "collectdPayloads": {
- "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
- "items": {
- "$ref": "CollectdPayload"
- },
- "type": "array"
- },
- "resource": {
- "$ref": "MonitoredResource",
- "description": "The monitored resource associated with the time series."
- },
- "collectdVersion": {
- "type": "string",
- "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\"."
- }
- }
+ "id": "ListGroupMembersResponse",
+ "description": "The ListGroupMembers response.",
+ "type": "object"
},
"ListMonitoredResourceDescriptorsResponse": {
"description": "The ListMonitoredResourceDescriptors response.",
@@ -1261,353 +854,17 @@
}
},
"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": {
- "resource": {
- "$ref": "MonitoredResource",
- "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data."
- },
- "metricKind": {
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ],
- "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.",
- "type": "string",
- "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."
- ]
- },
- "points": {
- "description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
- "items": {
- "$ref": "Point"
- },
- "type": "array"
- },
- "metric": {
- "$ref": "Metric",
- "description": "The associated metric. A fully-specified metric used to identify the time series."
- },
- "valueType": {
- "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"
- ],
- "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."
- }
- },
- "id": "TimeSeries"
- },
- "CreateTimeSeriesRequest": {
- "type": "object",
- "properties": {
- "timeSeries": {
- "items": {
- "$ref": "TimeSeries"
- },
- "type": "array",
- "description": "The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource."
- }
- },
- "id": "CreateTimeSeriesRequest",
- "description": "The CreateTimeSeries request."
- },
- "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": {
- "count": {
- "format": "int64",
- "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.",
- "type": "string"
- },
- "mean": {
- "format": "double",
- "description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
- "type": "number"
- },
- "bucketCounts": {
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array",
- "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."
- },
- "bucketOptions": {
- "$ref": "BucketOptions",
- "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries."
- },
- "sumOfSquaredDeviation": {
- "format": "double",
- "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is:\nSum[i=1..n]((x_i - mean)^2)\nKnuth, \"The Art of Computer Programming\", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.",
- "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."
- }
- },
- "id": "Distribution"
- },
- "MonitoredResource": {
- "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
- "type": "object",
- "properties": {
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\"."
- },
- "type": {
- "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"
- },
- "ListMetricDescriptorsResponse": {
- "properties": {
- "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."
- },
- "metricDescriptors": {
- "description": "The metric descriptors that are available to the project and that match the value of filter, if present.",
- "items": {
- "$ref": "MetricDescriptor"
- },
- "type": "array"
- }
- },
- "id": "ListMetricDescriptorsResponse",
- "description": "The ListMetricDescriptors response.",
- "type": "object"
- },
- "MonitoredResourceDescriptor": {
- "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
- "type": "object",
- "properties": {
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
- "type": "string"
- },
- "description": {
- "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
- "type": "string"
- },
- "displayName": {
- "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
- "type": "string"
- },
- "type": {
- "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
- "type": "string"
- }
- },
- "id": "MonitoredResourceDescriptor"
- },
- "TypedValue": {
- "description": "A single strongly-typed value.",
- "type": "object",
- "properties": {
- "doubleValue": {
- "format": "double",
- "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10\u003csup\u003e±300\u003c/sup\u003e and it has 16 significant digits of precision.",
- "type": "number"
- },
- "int64Value": {
- "type": "string",
- "format": "int64",
- "description": "A 64-bit integer. Its range is approximately ±9.2x10\u003csup\u003e18\u003c/sup\u003e."
- },
- "distributionValue": {
- "description": "A distribution value.",
- "$ref": "Distribution"
- },
- "stringValue": {
- "description": "A variable-length string value.",
- "type": "string"
- },
- "boolValue": {
- "type": "boolean",
- "description": "A Boolean value: true or false."
- }
- },
- "id": "TypedValue"
- },
- "CollectdPayload": {
- "type": "object",
- "properties": {
- "typeInstance": {
- "description": "The measurement type instance. Example: \"used\".",
- "type": "string"
- },
- "metadata": {
- "type": "object",
- "additionalProperties": {
- "$ref": "TypedValue"
- },
- "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345"
- },
- "type": {
- "type": "string",
- "description": "The measurement type. Example: \"memory\"."
- },
- "plugin": {
- "description": "The name of the plugin. Example: \"disk\".",
- "type": "string"
- },
- "pluginInstance": {
- "description": "The instance name of the plugin Example: \"hdcl\".",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The end time of the interval.",
- "type": "string"
- },
- "startTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The start time of the interval."
- },
- "values": {
- "description": "The measured values during this time interval. Each value must have a different dataSourceName.",
- "items": {
- "$ref": "CollectdValue"
- },
- "type": "array"
- }
- },
- "id": "CollectdPayload",
- "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information."
- },
- "Linear": {
- "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
- "type": "object",
- "properties": {
- "numFiniteBuckets": {
- "format": "int32",
- "description": "Must be greater than 0.",
- "type": "integer"
- },
- "width": {
- "format": "double",
- "description": "Must be greater than 0.",
- "type": "number"
- },
- "offset": {
- "format": "double",
- "description": "Lower bound of the first bucket.",
- "type": "number"
- }
- },
- "id": "Linear"
- },
- "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"
- },
- "Option": {
- "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
- "type": "object",
- "properties": {
- "value": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
- "type": "object"
- },
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".",
- "type": "string"
- }
- },
- "id": "Option"
- },
- "Explicit": {
- "type": "object",
- "properties": {
- "bounds": {
- "description": "The values must be monotonically increasing.",
- "items": {
- "format": "double",
- "type": "number"
- },
- "type": "array"
- }
- },
- "id": "Explicit",
- "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets."
- },
- "TimeInterval": {
- "description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.",
- "type": "object",
- "properties": {
- "startTime": {
- "format": "google-datetime",
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Required. The end of the time interval.",
- "type": "string"
- }
- },
- "id": "TimeInterval"
}
},
- "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": "Monitoring",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/monitoring.write": {
- "description": "Publish metric data to your Google Cloud projects"
- },
"https://www.googleapis.com/auth/monitoring.read": {
"description": "View monitoring data for all of your Google Cloud and third-party projects"
},
@@ -1616,6 +873,9 @@
},
"https://www.googleapis.com/auth/monitoring": {
"description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
+ },
+ "https://www.googleapis.com/auth/monitoring.write": {
+ "description": "Publish metric data to your Google Cloud projects"
}
}
}
@@ -1625,5 +885,745 @@
"name": "monitoring",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Monitoring API"
+ "title": "Stackdriver Monitoring API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "collectdTimeSeries": {
+ "methods": {
+ "create": {
+ "description": "Stackdriver Monitoring Agent only: Creates a new time series.\u003caside class=\"caution\"\u003eThis method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.\u003c/aside\u003e",
+ "request": {
+ "$ref": "CreateCollectdTimeSeriesRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/collectdTimeSeries",
+ "path": "v3/{+name}/collectdTimeSeries",
+ "id": "monitoring.projects.collectdTimeSeries.create"
+ }
+ }
+ },
+ "timeSeries": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/timeSeries",
+ "id": "monitoring.projects.timeSeries.create",
+ "path": "v3/{+name}/timeSeries",
+ "request": {
+ "$ref": "CreateTimeSeriesRequest"
+ },
+ "description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response."
+ },
+ "list": {
+ "description": "Lists time series that match a filter. This method does not require a Stackdriver account.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTimeSeriesResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "parameters": {
+ "aggregation.crossSeriesReducer": {
+ "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",
+ "location": "query"
+ },
+ "filter": {
+ "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
+ "type": "string",
+ "location": "query"
+ },
+ "aggregation.perSeriesAligner": {
+ "location": "query",
+ "enum": [
+ "ALIGN_NONE",
+ "ALIGN_DELTA",
+ "ALIGN_RATE",
+ "ALIGN_INTERPOLATE",
+ "ALIGN_NEXT_OLDER",
+ "ALIGN_MIN",
+ "ALIGN_MAX",
+ "ALIGN_MEAN",
+ "ALIGN_COUNT",
+ "ALIGN_SUM",
+ "ALIGN_STDDEV",
+ "ALIGN_COUNT_TRUE",
+ "ALIGN_FRACTION_TRUE",
+ "ALIGN_PERCENTILE_99",
+ "ALIGN_PERCENTILE_95",
+ "ALIGN_PERCENTILE_50",
+ "ALIGN_PERCENTILE_05"
+ ],
+ "description": "The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "interval.startTime": {
+ "format": "google-datetime",
+ "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
+ "type": "string",
+ "location": "query"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "FULL",
+ "HEADERS"
+ ],
+ "description": "Specifies which information is returned about the time series.",
+ "type": "string"
+ },
+ "aggregation.groupByFields": {
+ "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "name": {
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "interval.endTime": {
+ "location": "query",
+ "format": "google-datetime",
+ "description": "Required. The end of the time interval.",
+ "type": "string"
+ },
+ "aggregation.alignmentPeriod": {
+ "location": "query",
+ "format": "google-duration",
+ "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
+ "type": "integer",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/timeSeries",
+ "path": "v3/{+name}/timeSeries",
+ "id": "monitoring.projects.timeSeries.list"
+ }
+ }
+ },
+ "metricDescriptors": {
+ "methods": {
+ "create": {
+ "id": "monitoring.projects.metricDescriptors.create",
+ "path": "v3/{+name}/metricDescriptors",
+ "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.",
+ "request": {
+ "$ref": "MetricDescriptor"
+ },
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors"
+ },
+ "delete": {
+ "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$",
+ "location": "path",
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
+ "id": "monitoring.projects.metricDescriptors.delete",
+ "path": "v3/{+name}"
+ },
+ "get": {
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.metricDescriptors.get",
+ "description": "Gets a single metric descriptor. This method does not require a Stackdriver account.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$",
+ "location": "path",
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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}"
+ },
+ "list": {
+ "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListMetricDescriptorsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "A positive number that is the maximum number of results to return.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors",
+ "path": "v3/{+name}/metricDescriptors",
+ "id": "monitoring.projects.metricDescriptors.list"
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}",
+ "id": "monitoring.projects.monitoredResourceDescriptors.get",
+ "path": "v3/{+name}",
+ "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "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": {
+ "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"
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "A positive number that is the maximum number of results to return.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors",
+ "path": "v3/{+name}/monitoredResourceDescriptors",
+ "id": "monitoring.projects.monitoredResourceDescriptors.list",
+ "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account."
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "The group to delete. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "id": "monitoring.projects.groups.delete",
+ "path": "v3/{+name}",
+ "description": "Deletes an existing group."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.get",
+ "description": "Gets a single group."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListGroupsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "descendantsOfGroup": {
+ "location": "query",
+ "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "A positive number that is the maximum number of results to return.",
+ "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}\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "childrenOfGroup": {
+ "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups",
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.list",
+ "description": "Lists the existing groups."
+ },
+ "update": {
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, validate this request but do not update the existing group.",
+ "type": "boolean"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "id": "monitoring.projects.groups.update",
+ "path": "v3/{+name}",
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Updates an existing group. You can change any group attributes except name."
+ },
+ "create": {
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Creates a new group.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Group"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, validate this request but do not create the group.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups",
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.create"
+ }
+ },
+ "resources": {
+ "members": {
+ "methods": {
+ "list": {
+ "description": "Lists the monitored resources that are members of a group.",
+ "response": {
+ "$ref": "ListGroupMembersResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "interval.startTime": {
+ "location": "query",
+ "format": "google-datetime",
+ "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "A positive number that is the maximum number of results to return.",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path"
+ },
+ "interval.endTime": {
+ "format": "google-datetime",
+ "description": "Required. The end of the time interval.",
+ "type": "string",
+ "location": "query"
+ },
+ "filter": {
+ "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members",
+ "id": "monitoring.projects.groups.members.list",
+ "path": "v3/{+name}/members"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "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": ""
}
diff --git a/oslogin/v1alpha/oslogin-api.json b/oslogin/v1alpha/oslogin-api.json
index 0fa9589..a53459a 100644
--- a/oslogin/v1alpha/oslogin-api.json
+++ b/oslogin/v1alpha/oslogin-api.json
@@ -1,15 +1,313 @@
{
+ "title": "Google Cloud OS Login API",
+ "ownerName": "Google",
+ "resources": {
+ "users": {
+ "methods": {
+ "importSshPublicKey": {
+ "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.",
+ "request": {
+ "$ref": "SshPublicKey"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ImportSshPublicKeyResponse"
+ },
+ "parameters": {
+ "parent": {
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/users/{usersId}:importSshPublicKey",
+ "path": "v1alpha/{+parent}:importSshPublicKey",
+ "id": "oslogin.users.importSshPublicKey"
+ },
+ "getLoginProfile": {
+ "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
+ "response": {
+ "$ref": "LoginProfile"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^users/[^/]+$",
+ "location": "path",
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/users/{usersId}/loginProfile",
+ "id": "oslogin.users.getLoginProfile",
+ "path": "v1alpha/{+name}/loginProfile"
+ }
+ },
+ "resources": {
+ "sshPublicKeys": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "id": "oslogin.users.sshPublicKeys.delete",
+ "path": "v1alpha/{+name}",
+ "description": "Deletes an SSH public key."
+ },
+ "patch": {
+ "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
+ "request": {
+ "$ref": "SshPublicKey"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Mask to control which fields get updated. Updates all if not present.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1alpha/{+name}",
+ "id": "oslogin.users.sshPublicKeys.patch"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "parameters": {
+ "name": {
+ "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1alpha/{+name}",
+ "id": "oslogin.users.sshPublicKeys.get",
+ "description": "Retrieves an SSH public key."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1alpha",
+ "baseUrl": "https://oslogin.googleapis.com/",
+ "servicePath": "",
+ "kind": "discovery#restDescription",
+ "description": "Manages OS login configuration for Directory API users.",
"basePath": "",
+ "id": "oslogin:v1alpha",
"revision": "20170811",
"documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
- "id": "oslogin:v1alpha",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "SshPublicKey": {
+ "type": "object",
+ "properties": {
+ "expirationTimeUsec": {
+ "format": "int64",
+ "description": "An expiration time in microseconds since epoch.",
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "[Output Only] The SHA-256 fingerprint of the SSH public key.",
+ "type": "string"
+ },
+ "key": {
+ "description": "Public key text in SSH format, defined by\n\u003ca href=\"https://www.ietf.org/rfc/rfc4253.txt\" target=\"_blank\"\u003eRFC4253\u003c/a\u003e\nsection 6.6.",
+ "type": "string"
+ }
+ },
+ "id": "SshPublicKey",
+ "description": "The SSH public key information associated with a Directory API User."
+ },
+ "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": {}
+ },
+ "ImportSshPublicKeyResponse": {
+ "id": "ImportSshPublicKeyResponse",
+ "description": "A response message for importing an SSH public key.",
+ "type": "object",
+ "properties": {
+ "loginProfile": {
+ "description": "The login profile information for the user.",
+ "$ref": "LoginProfile"
+ }
+ }
+ },
"PosixAccount": {
"description": "The POSIX account information associated with a Directory API User.",
"type": "object",
"properties": {
+ "homeDirectory": {
+ "description": "The path to the home directory for this account.",
+ "type": "string"
+ },
+ "gecos": {
+ "description": "The GECOS (user information) entry for this account.",
+ "type": "string"
+ },
+ "systemId": {
+ "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "Only one POSIX account can be marked as primary.",
+ "type": "boolean"
+ },
"gid": {
"format": "uint32",
"description": "The default group ID.",
@@ -27,27 +325,12 @@
"shell": {
"description": "The path to the logic shell for this account.",
"type": "string"
- },
- "homeDirectory": {
- "description": "The path to the home directory for this account.",
- "type": "string"
- },
- "gecos": {
- "type": "string",
- "description": "The GECOS (user information) entry for this account."
- },
- "systemId": {
- "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
- "type": "string"
- },
- "primary": {
- "description": "Only one POSIX account can be marked as primary.",
- "type": "boolean"
}
},
"id": "PosixAccount"
},
"LoginProfile": {
+ "description": "The Directory API profile information used for logging in to a virtual\nmachine on Google Compute Engine.",
"type": "object",
"properties": {
"posixAccounts": {
@@ -73,61 +356,23 @@
}
}
},
- "id": "LoginProfile",
- "description": "The Directory API profile information used for logging in to a virtual\nmachine on Google Compute Engine."
- },
- "SshPublicKey": {
- "description": "The SSH public key information associated with a Directory API User.",
- "type": "object",
- "properties": {
- "expirationTimeUsec": {
- "format": "int64",
- "description": "An expiration time in microseconds since epoch.",
- "type": "string"
- },
- "fingerprint": {
- "description": "[Output Only] The SHA-256 fingerprint of the SSH public key.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "description": "Public key text in SSH format, defined by\n\u003ca href=\"https://www.ietf.org/rfc/rfc4253.txt\" target=\"_blank\"\u003eRFC4253\u003c/a\u003e\nsection 6.6."
- }
- },
- "id": "SshPublicKey"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ImportSshPublicKeyResponse": {
- "description": "A response message for importing an SSH public key.",
- "type": "object",
- "properties": {
- "loginProfile": {
- "$ref": "LoginProfile",
- "description": "The login profile information for the user."
- }
- },
- "id": "ImportSshPublicKeyResponse"
+ "id": "LoginProfile"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Cloud OS Login",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
}
}
}
@@ -135,250 +380,5 @@
"rootUrl": "https://oslogin.googleapis.com/",
"ownerDomain": "google.com",
"name": "oslogin",
- "batchPath": "batch",
- "title": "Google Cloud OS Login API",
- "ownerName": "Google",
- "resources": {
- "users": {
- "methods": {
- "importSshPublicKey": {
- "response": {
- "$ref": "ImportSshPublicKeyResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The unique ID for the user in format `users/{user}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+$"
- }
- },
- "flatPath": "v1alpha/users/{usersId}:importSshPublicKey",
- "id": "oslogin.users.importSshPublicKey",
- "path": "v1alpha/{+parent}:importSshPublicKey",
- "request": {
- "$ref": "SshPublicKey"
- },
- "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile."
- },
- "getLoginProfile": {
- "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "LoginProfile"
- },
- "parameters": {
- "name": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/users/{usersId}/loginProfile",
- "path": "v1alpha/{+name}/loginProfile",
- "id": "oslogin.users.getLoginProfile"
- }
- },
- "resources": {
- "sshPublicKeys": {
- "methods": {
- "delete": {
- "description": "Deletes an SSH public key.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.delete",
- "path": "v1alpha/{+name}"
- },
- "patch": {
- "request": {
- "$ref": "SshPublicKey"
- },
- "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Mask to control which fields get updated. Updates all if not present.",
- "type": "string"
- },
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.patch",
- "path": "v1alpha/{+name}"
- },
- "get": {
- "id": "oslogin.users.sshPublicKeys.get",
- "path": "v1alpha/{+name}",
- "description": "Retrieves an SSH public key.",
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$"
- }
- },
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "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": "v1alpha",
- "baseUrl": "https://oslogin.googleapis.com/",
- "description": "Manages OS login configuration for Directory API users.",
- "servicePath": "",
- "kind": "discovery#restDescription"
+ "batchPath": "batch"
}
diff --git a/partners/v2/partners-api.json b/partners/v2/partners-api.json
index 5a47e30..b8f6529 100644
--- a/partners/v2/partners-api.json
+++ b/partners/v2/partners-api.json
@@ -1,15 +1,11 @@
{
- "servicePath": "",
- "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
- "kind": "discovery#restDescription",
- "rootUrl": "https://partners.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "partners",
"batchPath": "batch",
- "id": "partners:v2",
- "documentationLink": "https://developers.google.com/partners/",
"revision": "20170822",
+ "documentationLink": "https://developers.google.com/partners/",
+ "id": "partners:v2",
"title": "Google Partners API",
"ownerName": "Google",
"discoveryVersion": "v1",
@@ -18,7 +14,6 @@
"leads": {
"methods": {
"list": {
- "description": "Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
"response": {
"$ref": "ListLeadsResponse"
},
@@ -31,9 +26,9 @@
"type": "string"
},
"requestMetadata.partnersSessionId": {
+ "location": "query",
"description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "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.",
@@ -41,31 +36,31 @@
"location": "query"
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
- "type": "integer"
+ "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.",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string",
"location": "query"
},
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
"type": "string",
"location": "query"
},
"requestMetadata.experimentIds": {
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
"type": "string",
- "repeated": true
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
},
"orderBy": {
"location": "query",
@@ -73,14 +68,15 @@
"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."
+ "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/leads",
"id": "partners.leads.list",
- "path": "v2/leads"
+ "path": "v2/leads",
+ "description": "Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user."
}
}
},
@@ -93,6 +89,27 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "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"
+ },
"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.",
@@ -104,28 +121,7 @@
"location": "query"
},
"requestMetadata.userOverrides.ipAddress": {
- "location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "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"
}
@@ -140,45 +136,26 @@
"history": {
"methods": {
"list": {
- "path": "v2/offers/history",
- "id": "partners.offers.history.list",
- "description": "Lists the Historical Offers for the current user (or user's entire company)",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListOffersHistoryResponse"
- },
"parameters": {
- "entireCompany": {
+ "orderBy": {
"location": "query",
- "description": "if true, show history for the entire company. Requires user to be admin.",
- "type": "boolean"
- },
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "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": "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"
},
- "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.",
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string",
"location": "query"
},
"requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
"type": "string",
"location": "query",
- "description": "Google Partners session ID."
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
},
"pageToken": {
"description": "Token to retrieve a specific page.",
@@ -197,84 +174,77 @@
"type": "string"
},
"requestMetadata.locale": {
+ "location": "query",
"description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
"location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
+ "description": "IP address to use instead of the user's geo-located IP address."
+ },
+ "entireCompany": {
+ "location": "query",
+ "description": "if true, show history for the entire company. Requires user to be admin.",
+ "type": "boolean"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
}
},
- "flatPath": "v2/offers/history"
+ "flatPath": "v2/offers/history",
+ "id": "partners.offers.history.list",
+ "path": "v2/offers/history",
+ "description": "Lists the Historical Offers for the current user (or user's entire company)",
+ "response": {
+ "$ref": "ListOffersHistoryResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET"
}
}
}
}
},
- "userStates": {
- "methods": {
- "list": {
- "description": "Lists states for current user.",
- "response": {
- "$ref": "ListUserStatesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "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": {
- "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",
- "id": "partners.userStates.list",
- "path": "v2/userStates"
- }
- }
- },
"analytics": {
"methods": {
"list": {
+ "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
"response": {
"$ref": "ListAnalyticsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
+ "requestMetadata.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": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListAnalyticsResponse.next_page_token`\nreturned from the previous call to\nListAnalytics.\nWill be a date string in `YYYY-MM-DD` format representing the end date\nof the date range of results to return.\nIf unspecified or set to \"\", default value is the current date.",
+ "type": "string"
+ },
"pageSize": {
"location": "query",
"format": "int32",
@@ -282,88 +252,60 @@
"type": "integer"
},
"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.",
- "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."
},
"requestMetadata.locale": {
- "description": "Locale to use for the current request.",
"type": "string",
- "location": "query"
+ "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",
- "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"
- },
+ }
+ },
+ "flatPath": "v2/analytics",
+ "id": "partners.analytics.list",
+ "path": "v2/analytics"
+ }
+ }
+ },
+ "userStates": {
+ "methods": {
+ "list": {
+ "description": "Lists states for current user.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListUserStatesResponse"
+ },
+ "parameters": {
"requestMetadata.userOverrides.userId": {
"description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string",
"location": "query"
},
"requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
"type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "flatPath": "v2/analytics",
- "id": "partners.analytics.list",
- "path": "v2/analytics",
- "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user."
- }
- }
- },
- "v2": {
- "methods": {
- "updateLeads": {
- "path": "v2/leads",
- "id": "partners.updateLeads",
- "request": {
- "$ref": "Lead"
- },
- "description": "Updates the specified lead.",
- "httpMethod": "PATCH",
- "parameterOrder": [],
- "response": {
- "$ref": "Lead"
- },
- "parameters": {
+ "description": "Google Partners session ID."
+ },
"requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.locale": {
+ "location": "query",
"description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
- },
- "updateMask": {
"location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
+ "description": "IP address to use instead of the user's geo-located IP address.",
"type": "string"
},
"requestMetadata.experimentIds": {
@@ -373,24 +315,131 @@
"location": "query"
},
"requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/userStates",
+ "path": "v2/userStates",
+ "id": "partners.userStates.list"
+ }
+ }
+ },
+ "v2": {
+ "methods": {
+ "getPartnersstatus": {
+ "response": {
+ "$ref": "GetPartnersStatusResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "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."
+ },
+ "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.userOverrides.userId": {
+ "requestMetadata.trafficSource.trafficSourceId": {
"type": "string",
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
+ "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": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
}
},
- "flatPath": "v2/leads"
+ "flatPath": "v2/partnersstatus",
+ "id": "partners.getPartnersstatus",
+ "path": "v2/partnersstatus",
+ "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"
+ },
+ "response": {
+ "$ref": "Lead"
+ },
+ "parameterOrder": [],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "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": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2/leads",
+ "id": "partners.updateLeads",
+ "path": "v2/leads"
},
"updateCompanies": {
+ "request": {
+ "$ref": "Company"
+ },
+ "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
"httpMethod": "PATCH",
"parameterOrder": [],
"response": {
@@ -413,9 +462,9 @@
"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": {
+ "location": "query",
"description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.ipAddress": {
"location": "query",
@@ -423,16 +472,16 @@
"type": "string"
},
"updateMask": {
- "location": "query",
"format": "google-fieldmask",
"description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.experimentIds": {
- "repeated": true,
"location": "query",
"description": "Experiment IDs the current request belongs to.",
- "type": "string"
+ "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.",
@@ -442,373 +491,13 @@
},
"flatPath": "v2/companies",
"path": "v2/companies",
- "id": "partners.updateCompanies",
- "request": {
- "$ref": "Company"
- },
- "description": "Update company.\nShould only be called within the context of an authorized logged in user."
- },
- "getPartnersstatus": {
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "GetPartnersStatusResponse"
- },
- "parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.experimentIds": {
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "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."
- }
- }
- },
- "companies": {
- "methods": {
- "list": {
- "id": "partners.companies.list",
- "path": "v2/companies",
- "description": "Lists companies.",
- "response": {
- "$ref": "ListCompaniesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "pageSize": {
- "format": "int32",
- "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "orderBy": {
- "location": "query",
- "description": "How to order addresses within the returned companies. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
- "type": "string"
- },
- "specializations": {
- "location": "query",
- "enum": [
- "BADGE_SPECIALIZATION_UNKNOWN",
- "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
- "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
- "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
- "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
- "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
- ],
- "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.",
- "type": "string",
- "repeated": true
- },
- "maxMonthlyBudget.currencyCode": {
- "location": "query",
- "description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "minMonthlyBudget.currencyCode": {
- "location": "query",
- "description": "The 3-letter currency code defined in ISO 4217.",
- "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": {
- "location": "query",
- "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
- "minMonthlyBudget.units": {
- "location": "query",
- "format": "int64",
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "type": "string"
- },
- "maxMonthlyBudget.nanos": {
- "location": "query",
- "format": "int32",
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "type": "integer"
- },
- "services": {
- "repeated": true,
- "location": "query",
- "enum": [
- "SERVICE_UNSPECIFIED",
- "S_ADVANCED_ADWORDS_SUPPORT",
- "S_ADVERTISING_ON_GOOGLE",
- "S_AN_ENHANCED_WEBSITE",
- "S_AN_ONLINE_MARKETING_PLAN",
- "S_MOBILE_AND_VIDEO_ADS",
- "S_MOBILE_WEBSITE_SERVICES"
- ],
- "description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "maxMonthlyBudget.units": {
- "location": "query",
- "format": "int64",
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "type": "string"
- },
- "minMonthlyBudget.nanos": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000."
- },
- "requestMetadata.trafficSource.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"
- },
- "companyName": {
- "location": "query",
- "description": "Company name to search for.",
- "type": "string"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies."
- },
- "industries": {
- "description": "List of industries the company can help with.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "INDUSTRY_UNSPECIFIED",
- "I_AUTOMOTIVE",
- "I_BUSINESS_TO_BUSINESS",
- "I_CONSUMER_PACKAGED_GOODS",
- "I_EDUCATION",
- "I_FINANCE",
- "I_HEALTHCARE",
- "I_MEDIA_AND_ENTERTAINMENT",
- "I_RETAIL",
- "I_TECHNOLOGY",
- "I_TRAVEL"
- ]
- },
- "websiteUrl": {
- "location": "query",
- "description": "Website URL that will help to find a better matched company.\n.",
- "type": "string"
- },
- "gpsMotivations": {
- "description": "List of reasons for using Google Partner Search to get companies.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "GPS_MOTIVATION_UNSPECIFIED",
- "GPSM_HELP_WITH_ADVERTISING",
- "GPSM_HELP_WITH_WEBSITE",
- "GPSM_NO_WEBSITE"
- ]
- }
- },
- "flatPath": "v2/companies"
- },
- "get": {
- "response": {
- "$ref": "GetCompanyResponse"
- },
- "parameterOrder": [
- "companyId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- },
- "currencyCode": {
- "location": "query",
- "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "description": "How to order addresses within the returned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.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"
- },
- "view": {
- "location": "query",
- "enum": [
- "COMPANY_VIEW_UNSPECIFIED",
- "CV_GOOGLE_PARTNER_SEARCH"
- ],
- "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
- "type": "string"
- },
- "address": {
- "location": "query",
- "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "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.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2/companies/{companyId}",
- "id": "partners.companies.get",
- "path": "v2/companies/{companyId}",
- "description": "Gets a company."
- }
- },
- "resources": {
- "leads": {
- "methods": {
- "create": {
- "description": "Creates an advertiser lead for the given company ID.",
- "request": {
- "$ref": "CreateLeadRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "companyId"
- ],
- "response": {
- "$ref": "CreateLeadResponse"
- },
- "parameters": {
- "companyId": {
- "location": "path",
- "description": "The ID of the company to contact.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2/companies/{companyId}/leads",
- "path": "v2/companies/{companyId}/leads",
- "id": "partners.companies.leads.create"
- }
- }
+ "id": "partners.updateCompanies"
}
}
},
"users": {
"methods": {
"updateProfile": {
- "flatPath": "v2/users/profile",
- "id": "partners.users.updateProfile",
- "path": "v2/users/profile",
"request": {
"$ref": "UserProfile"
},
@@ -830,9 +519,9 @@
"location": "query"
},
"requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.locale": {
"location": "query",
@@ -840,47 +529,40 @@
"type": "string"
},
"requestMetadata.userOverrides.ipAddress": {
- "type": "string",
"location": "query",
- "description": "IP address to use instead of the user's geo-located IP address."
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
},
"requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
"type": "string",
"repeated": true,
- "location": "query"
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
},
"requestMetadata.trafficSource.trafficSubId": {
"location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
}
- }
+ },
+ "flatPath": "v2/users/profile",
+ "id": "partners.users.updateProfile",
+ "path": "v2/users/profile"
},
"deleteCompanyRelation": {
"description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"userId"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
"requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.experimentIds": {
"location": "query",
@@ -900,21 +582,37 @@
"type": "string"
},
"requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"type": "string",
- "location": "query",
- "description": "Google Partners session ID."
+ "location": "query"
},
"requestMetadata.userOverrides.userId": {
"description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string",
"location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
}
},
"flatPath": "v2/users/{userId}/companyRelation",
- "id": "partners.users.deleteCompanyRelation",
- "path": "v2/users/{userId}/companyRelation"
+ "path": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.deleteCompanyRelation"
},
"createCompanyRelation": {
+ "id": "partners.users.createCompanyRelation",
+ "path": "v2/users/{userId}/companyRelation",
+ "request": {
+ "$ref": "CompanyRelation"
+ },
+ "description": "Creates a user's company relation. Affiliates the user to a company.",
"response": {
"$ref": "CompanyRelation"
},
@@ -923,26 +621,36 @@
],
"httpMethod": "PUT",
"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.",
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string",
"location": "query"
},
- "requestMetadata.locale": {
+ "requestMetadata.partnersSessionId": {
"location": "query",
- "description": "Locale to use for the current request.",
+ "description": "Google Partners session ID.",
"type": "string"
},
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "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.locale": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
},
"requestMetadata.experimentIds": {
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
"type": "string",
- "repeated": true
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
},
"requestMetadata.trafficSource.trafficSubId": {
"location": "query",
@@ -954,48 +662,40 @@
"type": "string",
"required": true,
"location": "path"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
}
},
- "flatPath": "v2/users/{userId}/companyRelation",
- "id": "partners.users.createCompanyRelation",
- "path": "v2/users/{userId}/companyRelation",
- "request": {
- "$ref": "CompanyRelation"
- },
- "description": "Creates a user's company relation. Affiliates the user to a company."
+ "flatPath": "v2/users/{userId}/companyRelation"
},
"get": {
- "flatPath": "v2/users/{userId}",
- "id": "partners.users.get",
- "path": "v2/users/{userId}",
"description": "Gets a user.",
- "response": {
- "$ref": "User"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"userId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "User"
+ },
"parameters": {
- "requestMetadata.userOverrides.userId": {
+ "requestMetadata.trafficSource.trafficSubId": {
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "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": {
+ "userId": {
+ "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "requestMetadata.userOverrides.userId": {
"type": "string",
"location": "query",
- "description": "Google Partners session ID."
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
},
"userView": {
"location": "query",
@@ -1008,36 +708,332 @@
"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",
+ "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.locale": {
+ "requestMetadata.userOverrides.ipAddress": {
"location": "query",
- "description": "Locale to use for the current request.",
+ "description": "IP address to use instead of the user's geo-located IP address.",
"type": "string"
},
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/users/{userId}",
+ "path": "v2/users/{userId}",
+ "id": "partners.users.get"
+ }
+ }
+ },
+ "companies": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListCompaniesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "gpsMotivations": {
+ "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.",
+ "type": "string"
+ },
+ "languageCodes": {
+ "location": "query",
+ "description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "type": "string",
+ "repeated": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
+ "type": "integer"
+ },
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
"type": "string",
"location": "query"
},
"requestMetadata.experimentIds": {
- "location": "query",
"description": "Experiment IDs the current request belongs to.",
"type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "How to order addresses within the returned companies. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
+ "type": "string"
+ },
+ "specializations": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "BADGE_SPECIALIZATION_UNKNOWN",
+ "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
+ "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
+ "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
+ "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
+ "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
+ ],
+ "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field."
+ },
+ "maxMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "minMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string",
+ "location": "query"
+ },
+ "view": {
+ "enum": [
+ "COMPANY_VIEW_UNSPECIFIED",
+ "CV_GOOGLE_PARTNER_SEARCH"
+ ],
+ "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "address": {
+ "type": "string",
+ "location": "query",
+ "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used."
+ },
+ "minMonthlyBudget.units": {
+ "type": "string",
+ "location": "query",
+ "format": "int64",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar."
+ },
+ "maxMonthlyBudget.nanos": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000."
+ },
+ "services": {
+ "location": "query",
+ "enum": [
+ "SERVICE_UNSPECIFIED",
+ "S_ADVANCED_ADWORDS_SUPPORT",
+ "S_ADVERTISING_ON_GOOGLE",
+ "S_AN_ENHANCED_WEBSITE",
+ "S_AN_ONLINE_MARKETING_PLAN",
+ "S_MOBILE_AND_VIDEO_ADS",
+ "S_MOBILE_WEBSITE_SERVICES"
+ ],
+ "description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.",
+ "type": "string",
"repeated": true
},
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "maxMonthlyBudget.units": {
+ "format": "int64",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "type": "string",
+ "location": "query"
+ },
"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": {
+ "format": "int32",
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "type": "integer",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "companyName": {
"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."
+ "description": "Company name to search for."
},
- "userId": {
- "location": "path",
- "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
+ "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": {
+ "enum": [
+ "INDUSTRY_UNSPECIFIED",
+ "I_AUTOMOTIVE",
+ "I_BUSINESS_TO_BUSINESS",
+ "I_CONSUMER_PACKAGED_GOODS",
+ "I_EDUCATION",
+ "I_FINANCE",
+ "I_HEALTHCARE",
+ "I_MEDIA_AND_ENTERTAINMENT",
+ "I_RETAIL",
+ "I_TECHNOLOGY",
+ "I_TRAVEL"
+ ],
+ "description": "List of industries the company can help with.",
"type": "string",
- "required": true
+ "repeated": true,
+ "location": "query"
+ },
+ "websiteUrl": {
+ "location": "query",
+ "description": "Website URL that will help to find a better matched company.\n.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/companies",
+ "id": "partners.companies.list",
+ "path": "v2/companies",
+ "description": "Lists companies."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "companyId"
+ ],
+ "response": {
+ "$ref": "GetCompanyResponse"
+ },
+ "parameters": {
+ "companyId": {
+ "description": "The ID of the company to retrieve.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "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": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "How to order addresses within the returned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "type": "string",
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "view": {
+ "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "COMPANY_VIEW_UNSPECIFIED",
+ "CV_GOOGLE_PARTNER_SEARCH"
+ ]
+ },
+ "address": {
+ "location": "query",
+ "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/companies/{companyId}",
+ "path": "v2/companies/{companyId}",
+ "id": "partners.companies.get",
+ "description": "Gets a company."
+ }
+ },
+ "resources": {
+ "leads": {
+ "methods": {
+ "create": {
+ "flatPath": "v2/companies/{companyId}/leads",
+ "id": "partners.companies.leads.create",
+ "path": "v2/companies/{companyId}/leads",
+ "description": "Creates an advertiser lead for the given company ID.",
+ "request": {
+ "$ref": "CreateLeadRequest"
+ },
+ "response": {
+ "$ref": "CreateLeadResponse"
+ },
+ "parameterOrder": [
+ "companyId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "companyId": {
+ "location": "path",
+ "description": "The ID of the company to contact.",
+ "type": "string",
+ "required": true
+ }
+ }
}
}
}
@@ -1046,25 +1042,28 @@
"userEvents": {
"methods": {
"log": {
- "flatPath": "v2/userEvents:log",
- "path": "v2/userEvents:log",
- "id": "partners.userEvents.log",
- "description": "Logs a user event.",
- "request": {
- "$ref": "LogUserEventRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "LogUserEventResponse"
},
- "parameters": {}
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v2/userEvents:log",
+ "id": "partners.userEvents.log",
+ "path": "v2/userEvents:log",
+ "request": {
+ "$ref": "LogUserEventRequest"
+ },
+ "description": "Logs a user event."
}
}
},
"clientMessages": {
"methods": {
"log": {
+ "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"
@@ -1074,10 +1073,7 @@
"response": {
"$ref": "LogMessageResponse"
},
- "parameters": {},
- "flatPath": "v2/clientMessages:log",
- "path": "v2/clientMessages:log",
- "id": "partners.clientMessages.log"
+ "parameters": {}
}
}
},
@@ -1085,19 +1081,34 @@
"methods": {
"getToken": {
"description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
- "response": {
- "$ref": "ExamToken"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"examType"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ExamToken"
+ },
"parameters": {
- "requestMetadata.locale": {
+ "requestMetadata.userOverrides.userId": {
"location": "query",
- "description": "Locale to use for the current request.",
+ "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.",
@@ -1115,6 +1126,10 @@
"type": "string"
},
"examType": {
+ "description": "The exam type we are requesting a token for.",
+ "type": "string",
+ "required": true,
+ "location": "path",
"enum": [
"CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
"CET_ADWORDS_FUNDAMENTALS",
@@ -1127,36 +1142,38 @@
"CET_MOBILE",
"CET_DIGITAL_SALES",
"CET_MOBILE_SITES"
- ],
- "description": "The exam type we are requesting a token for.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "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/exams/{examType}/token",
- "id": "partners.exams.getToken",
- "path": "v2/exams/{examType}/token"
+ "path": "v2/exams/{examType}/token",
+ "id": "partners.exams.getToken"
}
}
}
},
"parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
"callback": {
"description": "JSONP",
"type": "string",
@@ -1176,11 +1193,6 @@
"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",
@@ -1189,7 +1201,12 @@
"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"
+ ]
},
"access_token": {
"location": "query",
@@ -1202,9 +1219,9 @@
"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.",
@@ -1213,360 +1230,37 @@
"location": "query"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
}
},
"schemas": {
- "EventData": {
- "type": "object",
- "properties": {
- "key": {
- "enumDescriptions": [
- "Unchosen.",
- "Action data.",
- "Agency ID data.",
- "Agency name data.",
- "Agency phone number data.",
- "Agency website data.",
- "Budget data.",
- "Center-point data.",
- "Certification data.",
- "Comment data.",
- "Country data.",
- "Currency data.",
- "Currently viewed agency ID data.",
- "Distance data.",
- "Distance type data.",
- "Exam data.",
- "History token data.",
- "Identifier data.",
- "Industry data.",
- "Insight tag data.",
- "Language data.",
- "Location data.",
- "Marketing opt-in data.",
- "Query data.",
- "Search start index data.",
- "Service data.",
- "Show vow data.",
- "Solution data.",
- "Traffic source ID data.",
- "Traffic sub ID data.",
- "Viewport data.",
- "Website data.",
- "Details data.",
- "Experiment ID data.",
- "Google Partner Search motivation data.",
- "URL data.",
- "Element we wanted user to focus on.",
- "Progress when viewing an item \\[0-100\\]."
- ],
- "enum": [
- "EVENT_DATA_TYPE_UNSPECIFIED",
- "ACTION",
- "AGENCY_ID",
- "AGENCY_NAME",
- "AGENCY_PHONE_NUMBER",
- "AGENCY_WEBSITE",
- "BUDGET",
- "CENTER_POINT",
- "CERTIFICATION",
- "COMMENT",
- "COUNTRY",
- "CURRENCY",
- "CURRENTLY_VIEWED_AGENCY_ID",
- "DISTANCE",
- "DISTANCE_TYPE",
- "EXAM",
- "HISTORY_TOKEN",
- "ID",
- "INDUSTRY",
- "INSIGHT_TAG",
- "LANGUAGE",
- "LOCATION",
- "MARKETING_OPT_IN",
- "QUERY",
- "SEARCH_START_INDEX",
- "SERVICE",
- "SHOW_VOW",
- "SOLUTION",
- "TRAFFIC_SOURCE_ID",
- "TRAFFIC_SUB_ID",
- "VIEW_PORT",
- "WEBSITE",
- "DETAILS",
- "EXPERIMENT_ID",
- "GPS_MOTIVATION",
- "URL",
- "ELEMENT_FOCUS",
- "PROGRESS"
- ],
- "description": "Data type.",
- "type": "string"
- },
- "values": {
- "description": "Data values.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "EventData",
- "description": "Key value data pair for an event."
- },
- "ExamStatus": {
- "type": "object",
- "properties": {
- "expiration": {
- "format": "google-datetime",
- "description": "Date this exam is due to expire.",
- "type": "string"
- },
- "warning": {
- "description": "Whether this exam is in the state of warning.",
- "type": "boolean"
- },
- "lastPassed": {
- "format": "google-datetime",
- "description": "The date the user last passed this exam.",
- "type": "string"
- },
- "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"
- ]
- },
- "passed": {
- "description": "Whether this exam has been passed and not expired.",
- "type": "boolean"
- },
- "taken": {
- "format": "google-datetime",
- "description": "The date the user last taken this exam.",
- "type": "string"
- }
- },
- "id": "ExamStatus",
- "description": "A user's information on a specific exam."
- },
- "ListOffersResponse": {
- "description": "Response for ListOffer.",
- "type": "object",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "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.",
- "items": {
- "$ref": "AvailableOffer"
- },
- "type": "array"
- }
- },
- "id": "ListOffersResponse"
- },
- "CountryOfferInfo": {
- "description": "Offer info by country.",
- "type": "object",
- "properties": {
- "offerType": {
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ],
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "description": "Type of offer country is eligible for.",
- "type": "string"
- },
- "getYAmount": {
- "description": "(localized) Get Y amount for that country's offer.",
- "type": "string"
- },
- "spendXAmount": {
- "description": "(localized) Spend X amount for that country's offer.",
- "type": "string"
- },
- "offerCountryCode": {
- "description": "Country code for which offer codes may be requested.",
- "type": "string"
- }
- },
- "id": "CountryOfferInfo"
- },
- "ListCompaniesResponse": {
- "description": "Response message for\nListCompanies.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "companies": {
- "description": "The list of companies.",
- "items": {
- "$ref": "Company"
- },
- "type": "array"
- }
- },
- "id": "ListCompaniesResponse"
- },
- "OfferCustomer": {
- "description": "Customers qualified for an offer.",
- "type": "object",
- "properties": {
- "spendXAmount": {
- "description": "Formatted Spend X amount with currency code.",
- "type": "string"
- },
- "adwordsUrl": {
- "description": "URL to the customer's AdWords page.",
- "type": "string"
- },
- "creationTime": {
- "format": "google-datetime",
- "description": "Time the customer was created.",
- "type": "string"
- },
- "countryCode": {
- "description": "Country code of the customer.",
- "type": "string"
- },
- "eligibilityDaysLeft": {
- "format": "int32",
- "description": "Days the customer is still eligible.",
- "type": "integer"
- },
- "offerType": {
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ],
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "description": "Type of the offer",
- "type": "string"
- },
- "externalCid": {
- "format": "int64",
- "description": "External CID for the customer.",
- "type": "string"
- },
- "getYAmount": {
- "description": "Formatted Get Y amount with currency code.",
- "type": "string"
- },
- "name": {
- "description": "Name of the customer.",
- "type": "string"
- }
- },
- "id": "OfferCustomer"
- },
"CertificationStatus": {
"id": "CertificationStatus",
"description": "Google Partners certification status.",
"type": "object",
"properties": {
+ "userCount": {
+ "format": "int32",
+ "description": "Number of people who are certified,",
+ "type": "integer"
+ },
"isCertified": {
"description": "Whether certification is passing.",
"type": "boolean"
},
"examStatuses": {
- "description": "List of certification exam statuses.",
"items": {
"$ref": "CertificationExamStatus"
},
- "type": "array"
+ "type": "array",
+ "description": "List of certification exam statuses."
},
"type": {
"enumDescriptions": [
@@ -1599,27 +1293,13 @@
],
"description": "The type of the certification.",
"type": "string"
- },
- "userCount": {
- "format": "int32",
- "description": "Number of people who are certified,",
- "type": "integer"
}
}
},
"LocalizedCompanyInfo": {
- "id": "LocalizedCompanyInfo",
"description": "The localized company information.",
"type": "object",
"properties": {
- "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"
@@ -1630,8 +1310,17 @@
"type": "string"
},
"type": "array"
+ },
+ "overview": {
+ "description": "Localized brief description that the company uses to advertise themselves.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized display name.",
+ "type": "string"
}
- }
+ },
+ "id": "LocalizedCompanyInfo"
},
"LogUserEventResponse": {
"type": "object",
@@ -1648,14 +1337,22 @@
"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."
+ "description": "True if the user has the option to show entire company history.",
+ "type": "boolean"
},
"totalResults": {
- "type": "integer",
"format": "int32",
- "description": "Number of results across all pages."
+ "description": "Number of results across all pages.",
+ "type": "integer"
},
"showingEntireCompany": {
"description": "True if this response is showing entire company history.",
@@ -1667,36 +1364,26 @@
"$ref": "HistoricalOffer"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
- "type": "string"
- },
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
}
},
"id": "ListOffersHistoryResponse"
},
"LogMessageResponse": {
- "description": "Response message for\nLogClientMessage.",
"type": "object",
"properties": {
"responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
- "id": "LogMessageResponse"
+ "id": "LogMessageResponse",
+ "description": "Response message for\nLogClientMessage."
},
"SpecializationStatus": {
"description": "Agency specialization status",
"type": "object",
"properties": {
"badgeSpecialization": {
- "description": "The specialization this status is for.",
- "type": "string",
"enumDescriptions": [
"Unknown specialization",
"AdWords Search specialization",
@@ -1712,15 +1399,11 @@
"BADGE_SPECIALIZATION_ADWORDS_MOBILE",
"BADGE_SPECIALIZATION_ADWORDS_VIDEO",
"BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
- ]
+ ],
+ "description": "The specialization this status is for.",
+ "type": "string"
},
"badgeSpecializationState": {
- "enumDescriptions": [
- "Unknown state",
- "Specialization passed",
- "Specialization not passed",
- "Specialization in grace"
- ],
"enum": [
"BADGE_SPECIALIZATION_STATE_UNKNOWN",
"BADGE_SPECIALIZATION_STATE_PASSED",
@@ -1728,12 +1411,19 @@
"BADGE_SPECIALIZATION_STATE_IN_GRACE"
],
"description": "State of agency specialization.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown state",
+ "Specialization passed",
+ "Specialization not passed",
+ "Specialization in grace"
+ ]
}
},
"id": "SpecializationStatus"
},
"Certification": {
+ "description": "A user's information on a specific certification.",
"type": "object",
"properties": {
"warning": {
@@ -1750,7 +1440,6 @@
"type": "boolean"
},
"certificationType": {
- "description": "The type of certification, the area of expertise.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
@@ -1779,7 +1468,8 @@
"CT_ADWORDS_SEARCH",
"CT_ADWORDS_DISPLAY",
"CT_MOBILE_SITES"
- ]
+ ],
+ "description": "The type of certification, the area of expertise."
},
"lastAchieved": {
"format": "google-datetime",
@@ -1787,24 +1477,23 @@
"type": "string"
}
},
- "id": "Certification",
- "description": "A user's information on a specific certification."
+ "id": "Certification"
},
"User": {
- "description": "A resource representing a user of the Partners platform.",
"type": "object",
"properties": {
- "lastAccessTime": {
- "format": "google-datetime",
- "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
- "type": "string"
+ "profile": {
+ "$ref": "UserProfile",
+ "description": "The profile information of a Partners user, contains all the directly\neditable user information."
},
- "availableAdwordsManagerAccounts": {
- "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
- "items": {
- "$ref": "AdWordsManagerAccountInfo"
- },
- "type": "array"
+ "company": {
+ "$ref": "CompanyRelation",
+ "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
+ },
+ "lastAccessTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly"
},
"primaryEmails": {
"description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
@@ -1813,24 +1502,35 @@
},
"type": "array"
},
+ "availableAdwordsManagerAccounts": {
+ "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
+ "items": {
+ "$ref": "AdWordsManagerAccountInfo"
+ },
+ "type": "array"
+ },
"internalId": {
"description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
"type": "string"
},
"examStatus": {
- "description": "The list of exams the user ever taken. For each type of exam, only one\nentry is listed.",
"items": {
"$ref": "ExamStatus"
},
- "type": "array"
+ "type": "array",
+ "description": "The list of exams the user ever taken. For each type of exam, only one\nentry is listed."
},
"id": {
"description": "The ID of the user.",
"type": "string"
},
"publicProfile": {
- "description": "Information about a user's external public profile outside Google Partners.",
- "$ref": "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",
@@ -1838,29 +1538,25 @@
"$ref": "Certification"
},
"type": "array"
- },
- "companyVerificationEmail": {
- "description": "The email address used by the user used for company verification.\n@OutputOnly",
- "type": "string"
- },
- "profile": {
- "description": "The profile information of a Partners user, contains all the directly\neditable user information.",
- "$ref": "UserProfile"
- },
- "company": {
- "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company.",
- "$ref": "CompanyRelation"
}
},
- "id": "User"
+ "id": "User",
+ "description": "A resource representing a user of the Partners platform."
},
"ListAnalyticsResponse": {
"description": "Response message for\nListAnalytics.",
"type": "object",
"properties": {
+ "analytics": {
+ "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
+ "items": {
+ "$ref": "Analytics"
+ },
+ "type": "array"
+ },
"nextPageToken": {
- "type": "string",
- "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results."
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.",
+ "type": "string"
},
"analyticsSummary": {
"description": "Aggregated information across the response's\nanalytics.",
@@ -1869,173 +1565,20 @@
"responseMetadata": {
"$ref": "ResponseMetadata",
"description": "Current response metadata."
- },
- "analytics": {
- "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
- "items": {
- "$ref": "Analytics"
- },
- "type": "array"
}
},
"id": "ListAnalyticsResponse"
},
- "ListLeadsResponse": {
- "description": "Response message for ListLeads.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent call to\nListLeads to retrieve the\nnext page of results.",
- "type": "string"
- },
- "totalSize": {
- "format": "int32",
- "description": "The total count of leads for the given company.",
- "type": "integer"
- },
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
- },
- "leads": {
- "description": "The list of leads.",
- "items": {
- "$ref": "Lead"
- },
- "type": "array"
- }
- },
- "id": "ListLeadsResponse"
- },
"Company": {
"description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
"type": "object",
"properties": {
- "locations": {
- "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
- },
- "convertedMinMonthlyBudget": {
- "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code.",
- "$ref": "Money"
- },
- "industries": {
- "items": {
- "enum": [
- "INDUSTRY_UNSPECIFIED",
- "I_AUTOMOTIVE",
- "I_BUSINESS_TO_BUSINESS",
- "I_CONSUMER_PACKAGED_GOODS",
- "I_EDUCATION",
- "I_FINANCE",
- "I_HEALTHCARE",
- "I_MEDIA_AND_ENTERTAINMENT",
- "I_RETAIL",
- "I_TECHNOLOGY",
- "I_TRAVEL"
- ],
- "type": "string"
- },
- "type": "array",
- "enumDescriptions": [
- "Unchosen.",
- "The automotive industry.",
- "The business-to-business industry.",
- "The consumer packaged goods industry.",
- "The education industry.",
- "The finance industry.",
- "The healthcare industry.",
- "The media and entertainment industry.",
- "The retail industry.",
- "The technology industry.",
- "The travel industry."
- ],
- "description": "Industries the company can help with."
- },
- "additionalWebsites": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "URL of the company's additional websites used to verify the dynamic badges.\nThese are stored as full URLs as entered by the user, but only the TLD will\nbe used for the actual verification."
- },
- "websiteUrl": {
- "description": "URL of the company's website.",
- "type": "string"
- },
- "primaryAdwordsManagerAccountId": {
- "format": "int64",
- "description": "The Primary AdWords Manager Account id.",
- "type": "string"
- },
- "name": {
- "description": "The name of the company.",
- "type": "string"
- },
- "localizedInfos": {
- "description": "The list of localized info for the company.",
- "items": {
- "$ref": "LocalizedCompanyInfo"
- },
- "type": "array"
- },
- "id": {
- "type": "string",
- "description": "The ID of the company."
- },
- "certificationStatuses": {
- "description": "The list of Google Partners certification statuses for the company.",
- "items": {
- "$ref": "CertificationStatus"
- },
- "type": "array"
- },
- "originalMinMonthlyBudget": {
- "$ref": "Money",
- "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness."
- },
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Basic information from the company's public profile."
- },
- "primaryLocation": {
- "description": "The primary location of the company.",
- "$ref": "Location"
- },
- "services": {
- "description": "Services the company can help with.",
- "items": {
- "enum": [
- "SERVICE_UNSPECIFIED",
- "S_ADVANCED_ADWORDS_SUPPORT",
- "S_ADVERTISING_ON_GOOGLE",
- "S_AN_ENHANCED_WEBSITE",
- "S_AN_ONLINE_MARKETING_PLAN",
- "S_MOBILE_AND_VIDEO_ADS",
- "S_MOBILE_WEBSITE_SERVICES"
- ],
- "type": "string"
- },
- "type": "array",
- "enumDescriptions": [
- "Unchosen.",
- "Help with advanced AdWords support.",
- "Help with advertising on Google.",
- "Help with an enhanced website.",
- "Help with an online marketing plan.",
- "Help with mobile and video ads.",
- "Help with mobile websites."
- ]
- },
"ranks": {
+ "description": "Information related to the ranking of the company within the list of\ncompanies.",
"items": {
"$ref": "Rank"
},
- "type": "array",
- "description": "Information related to the ranking of the company within the list of\ncompanies."
+ "type": "array"
},
"specializationStatus": {
"description": "The list of Google Partners specialization statuses for the company.",
@@ -2066,24 +1609,6 @@
"type": "array"
},
"companyTypes": {
- "description": "Company type labels listed on the company's profile.",
- "items": {
- "type": "string",
- "enum": [
- "COMPANY_TYPE_UNSPECIFIED",
- "FULL_SERVICE_AGENCY",
- "MEDIA_AGENCY",
- "CREATIVE_AGENCY",
- "CDIGITAL_AGENCY",
- "SEM_SEO",
- "PERFORMANCE_MARKETING",
- "ADVERTISING_TOOL_DEVELOPMENT",
- "PR",
- "SELF_MANAGED",
- "RESELLER"
- ]
- },
- "type": "array",
"enumDescriptions": [
"Unchosen.",
"Handles all aspects of the advertising process.",
@@ -2096,7 +1621,25 @@
"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.",
+ "items": {
+ "enum": [
+ "COMPANY_TYPE_UNSPECIFIED",
+ "FULL_SERVICE_AGENCY",
+ "MEDIA_AGENCY",
+ "CREATIVE_AGENCY",
+ "CDIGITAL_AGENCY",
+ "SEM_SEO",
+ "PERFORMANCE_MARKETING",
+ "ADVERTISING_TOOL_DEVELOPMENT",
+ "PR",
+ "SELF_MANAGED",
+ "RESELLER"
+ ],
+ "type": "string"
+ },
+ "type": "array"
},
"profileStatus": {
"enum": [
@@ -2117,22 +1660,165 @@
"primaryLanguageCode": {
"description": "The primary language code of the company, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
"type": "string"
+ },
+ "locations": {
+ "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "convertedMinMonthlyBudget": {
+ "$ref": "Money",
+ "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code."
+ },
+ "industries": {
+ "description": "Industries the company can help with.",
+ "items": {
+ "enum": [
+ "INDUSTRY_UNSPECIFIED",
+ "I_AUTOMOTIVE",
+ "I_BUSINESS_TO_BUSINESS",
+ "I_CONSUMER_PACKAGED_GOODS",
+ "I_EDUCATION",
+ "I_FINANCE",
+ "I_HEALTHCARE",
+ "I_MEDIA_AND_ENTERTAINMENT",
+ "I_RETAIL",
+ "I_TECHNOLOGY",
+ "I_TRAVEL"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Unchosen.",
+ "The automotive industry.",
+ "The business-to-business industry.",
+ "The consumer packaged goods industry.",
+ "The education industry.",
+ "The finance industry.",
+ "The healthcare industry.",
+ "The media and entertainment industry.",
+ "The retail industry.",
+ "The technology industry.",
+ "The travel industry."
+ ]
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "primaryAdwordsManagerAccountId": {
+ "format": "int64",
+ "description": "The Primary AdWords Manager Account id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the company.",
+ "type": "string"
+ },
+ "localizedInfos": {
+ "description": "The list of localized info for the company.",
+ "items": {
+ "$ref": "LocalizedCompanyInfo"
+ },
+ "type": "array"
+ },
+ "certificationStatuses": {
+ "description": "The list of Google Partners certification statuses for the company.",
+ "items": {
+ "$ref": "CertificationStatus"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "The ID of the company.",
+ "type": "string"
+ },
+ "originalMinMonthlyBudget": {
+ "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness.",
+ "$ref": "Money"
+ },
+ "services": {
+ "description": "Services the company can help with.",
+ "items": {
+ "enum": [
+ "SERVICE_UNSPECIFIED",
+ "S_ADVANCED_ADWORDS_SUPPORT",
+ "S_ADVERTISING_ON_GOOGLE",
+ "S_AN_ENHANCED_WEBSITE",
+ "S_AN_ONLINE_MARKETING_PLAN",
+ "S_MOBILE_AND_VIDEO_ADS",
+ "S_MOBILE_WEBSITE_SERVICES"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Help with advanced AdWords support.",
+ "Help with advertising on Google.",
+ "Help with an enhanced website.",
+ "Help with an online marketing plan.",
+ "Help with mobile and video ads.",
+ "Help with mobile websites."
+ ]
+ },
+ "primaryLocation": {
+ "$ref": "Location",
+ "description": "The primary location of the company."
+ },
+ "publicProfile": {
+ "description": "Basic information from the company's public profile.",
+ "$ref": "PublicProfile"
}
},
"id": "Company"
},
+ "ListLeadsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent call to\nListLeads to retrieve the\nnext page of results.",
+ "type": "string"
+ },
+ "totalSize": {
+ "format": "int32",
+ "description": "The total count of leads for the given company.",
+ "type": "integer"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "leads": {
+ "description": "The list of leads.",
+ "items": {
+ "$ref": "Lead"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListLeadsResponse",
+ "description": "Response message for ListLeads."
+ },
"CreateLeadResponse": {
- "id": "CreateLeadResponse",
"description": "Response message for CreateLead.",
"type": "object",
"properties": {
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ },
"recaptchaStatus": {
- "enumDescriptions": [
- "Unchosen.",
- "No reCaptcha validation needed.",
- "reCaptcha challenge passed.",
- "reCaptcha challenge failed."
- ],
"enum": [
"RECAPTCHA_STATUS_UNSPECIFIED",
"RS_NOT_NEEDED",
@@ -2140,32 +1826,35 @@
"RS_FAILED"
],
"description": "The outcome of \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nvalidation.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "No reCaptcha validation needed.",
+ "reCaptcha challenge passed.",
+ "reCaptcha challenge failed."
+ ]
},
"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"
- },
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
+ "$ref": "Lead",
+ "description": "Lead that was created depending on the outcome of\n\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e validation."
}
- }
+ },
+ "id": "CreateLeadResponse"
},
"GetCompanyResponse": {
- "description": "Response message for GetCompany.",
- "type": "object",
"properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
"company": {
"$ref": "Company",
"description": "The company."
- },
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
}
},
- "id": "GetCompanyResponse"
+ "id": "GetCompanyResponse",
+ "description": "Response message for GetCompany.",
+ "type": "object"
},
"Location": {
"description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
@@ -2180,8 +1869,8 @@
"type": "string"
},
"latLng": {
- "$ref": "LatLng",
- "description": "The latitude and longitude of the location, in degrees."
+ "description": "The latitude and longitude of the location, in degrees.",
+ "$ref": "LatLng"
},
"address": {
"description": "The single string version of the address.",
@@ -2200,12 +1889,12 @@
"type": "string"
},
"languageCode": {
- "type": "string",
- "description": "Language code of the address. Should be in BCP 47 format."
+ "description": "Language code of the address. Should be in BCP 47 format.",
+ "type": "string"
},
"sortingCode": {
- "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail.",
- "type": "string"
+ "type": "string",
+ "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail."
},
"addressLine": {
"description": "The following address lines represent the most specific part of any\naddress.",
@@ -2218,6 +1907,7 @@
"id": "Location"
},
"CertificationExamStatus": {
+ "id": "CertificationExamStatus",
"description": "Status for a Google Partners certification exam.",
"type": "object",
"properties": {
@@ -2227,6 +1917,19 @@
"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",
@@ -2241,25 +1944,12 @@
"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."
- ]
+ "type": "string"
}
- },
- "id": "CertificationExamStatus"
+ }
},
"ExamToken": {
+ "id": "ExamToken",
"description": "A token that allows a user to take an exam.",
"type": "object",
"properties": {
@@ -2302,11 +1992,9 @@
"description": "The type of the exam the token belongs to.",
"type": "string"
}
- },
- "id": "ExamToken"
+ }
},
"OptIns": {
- "id": "OptIns",
"description": "A set of opt-ins for a user.",
"type": "object",
"properties": {
@@ -2319,18 +2007,19 @@
"type": "boolean"
},
"phoneContact": {
- "type": "boolean",
- "description": "An opt-in to allow recieivng phone calls about their Partners account."
+ "description": "An opt-in to allow recieivng phone calls about their Partners account.",
+ "type": "boolean"
},
"physicalMail": {
- "description": "An opt-in to receive special promotional gifts and material in the mail.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "An opt-in to receive special promotional gifts and material in the mail."
},
"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"
+ "type": "boolean",
+ "description": "An opt-in about receiving email from Partners marketing teams. Includes\nmember-only events and special promotional offers for Google products."
}
- }
+ },
+ "id": "OptIns"
},
"Rank": {
"description": "Information related to ranking of results.",
@@ -2356,7 +2045,19 @@
},
"id": "Rank"
},
+ "GetPartnersStatusResponse": {
+ "description": "Response message for\nGetPartnersStatus.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "GetPartnersStatusResponse"
+ },
"UserProfile": {
+ "id": "UserProfile",
"description": "The profile information of a Partners user.",
"type": "object",
"properties": {
@@ -2365,8 +2066,8 @@
"type": "string"
},
"address": {
- "$ref": "Location",
- "description": "The user's mailing address, contains multiple fields."
+ "description": "The user's mailing address, contains multiple fields.",
+ "$ref": "Location"
},
"industries": {
"description": "A list of ids representing which industries the user selected.",
@@ -2375,20 +2076,20 @@
},
"type": "array"
},
- "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
"familyName": {
"type": "string",
"description": "The user's family name."
},
- "languages": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The list of languages this user understands."
+ "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.",
@@ -2414,16 +2115,16 @@
"description": "The email address the user has selected on the Partners site as primary.",
"type": "string"
},
- "profilePublic": {
- "description": "Whether the user's public profile is visible to anyone with the URL.",
- "type": "boolean"
- },
"channels": {
+ "description": "A list of ids representing which channels the user selected they were in.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "A list of ids representing which channels the user selected they were in."
+ "type": "array"
+ },
+ "profilePublic": {
+ "description": "Whether the user's public profile is visible to anyone with the URL.",
+ "type": "boolean"
},
"jobFunctions": {
"description": "A list of ids represnting which job categories the user selected.",
@@ -2432,60 +2133,25 @@
},
"type": "array"
}
- },
- "id": "UserProfile"
- },
- "GetPartnersStatusResponse": {
- "description": "Response message for\nGetPartnersStatus.",
- "type": "object",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "GetPartnersStatusResponse"
+ }
},
"HistoricalOffer": {
+ "id": "HistoricalOffer",
"description": "Historical information about a Google Partners Offer.",
"type": "object",
"properties": {
- "adwordsUrl": {
- "description": "Client's AdWords page URL.",
- "type": "string"
- },
- "offerType": {
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ],
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "description": "Type of offer.",
- "type": "string"
- },
- "senderName": {
- "description": "Name (First + Last) of the partners user to whom the incentive is allocated.",
- "type": "string"
- },
"offerCountryCode": {
"description": "Country Code for the offer country.",
"type": "string"
},
"expirationTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "Time this offer expires.",
- "type": "string"
+ "description": "Time this offer expires."
},
"offerCode": {
- "description": "Offer code.",
- "type": "string"
+ "type": "string",
+ "description": "Offer code."
},
"creationTime": {
"format": "google-datetime",
@@ -2493,6 +2159,8 @@
"type": "string"
},
"status": {
+ "description": "Status of the offer.",
+ "type": "string",
"enumDescriptions": [
"Unset.",
"Offer distributed.",
@@ -2506,9 +2174,7 @@
"OFFER_STATUS_REDEEMED",
"OFFER_STATUS_AWARDED",
"OFFER_STATUS_EXPIRED"
- ],
- "description": "Status of the offer.",
- "type": "string"
+ ]
},
"clientEmail": {
"description": "Email address for client.",
@@ -2527,104 +2193,37 @@
"format": "google-datetime",
"description": "Time last action was taken.",
"type": "string"
- }
- },
- "id": "HistoricalOffer"
- },
- "UserOverrides": {
- "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.",
- "type": "object",
- "properties": {
- "userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ },
+ "adwordsUrl": {
+ "description": "Client's AdWords page URL.",
"type": "string"
},
- "ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
+ "offerType": {
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of offer.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ]
+ },
+ "senderName": {
+ "type": "string",
+ "description": "Name (First + Last) of the partners user to whom the incentive is allocated."
}
- },
- "id": "UserOverrides"
+ }
},
"LogUserEventRequest": {
"description": "Request message for\nLogUserEvent.",
"type": "object",
"properties": {
- "url": {
- "description": "The URL where the event occurred.",
- "type": "string"
- },
- "requestMetadata": {
- "description": "Current request metadata.",
- "$ref": "RequestMetadata"
- },
- "eventDatas": {
- "description": "List of event data for the event.",
- "items": {
- "$ref": "EventData"
- },
- "type": "array"
- },
- "eventScope": {
- "enum": [
- "EVENT_SCOPE_UNSPECIFIED",
- "VISITOR",
- "SESSION",
- "PAGE"
- ],
- "description": "The scope of the event.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Based on visitor.",
- "Based on session.",
- "Based on page visit."
- ]
- },
- "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_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"
- },
- "lead": {
- "$ref": "Lead",
- "description": "Advertiser lead information."
- },
"eventAction": {
"description": "The action that occurred.",
"type": "string",
@@ -2946,33 +2545,125 @@
"AGENCY_CLICKED_CANCEL_ACCEPT_TOS_BUTTON",
"SMB_ENTERED_WEBSITE_IN_CONTACT_PARTNER_FORM"
]
+ },
+ "url": {
+ "description": "The URL where the event occurred.",
+ "type": "string"
+ },
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ },
+ "eventDatas": {
+ "items": {
+ "$ref": "EventData"
+ },
+ "type": "array",
+ "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": [
+ "Unchosen.",
+ "Based on visitor.",
+ "Based on session.",
+ "Based on page visit."
+ ]
+ },
+ "eventCategory": {
+ "description": "The category the action belongs to.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Google Partner Search category.",
+ "Google Partner sign-up flow category.",
+ "Google Partner portal category.",
+ "Google Partner portal my-profile category.",
+ "Google Partner portal certifications category.",
+ "Google Partner portal community category.",
+ "Google Partner portal insights category.",
+ "Google Partner portal clients category.",
+ "Google Partner portal public user profile category.",
+ "Google Partner panel category.",
+ "Google Partner portal last admin dialog category.",
+ "Google Partner client category.",
+ "Google Partner portal company profile category.",
+ "External links category.",
+ "Google Partner landing category."
+ ],
+ "enum": [
+ "EVENT_CATEGORY_UNSPECIFIED",
+ "GOOGLE_PARTNER_SEARCH",
+ "GOOGLE_PARTNER_SIGNUP_FLOW",
+ "GOOGLE_PARTNER_PORTAL",
+ "GOOGLE_PARTNER_PORTAL_MY_PROFILE",
+ "GOOGLE_PARTNER_PORTAL_CERTIFICATIONS",
+ "GOOGLE_PARTNER_PORTAL_COMMUNITY",
+ "GOOGLE_PARTNER_PORTAL_INSIGHTS",
+ "GOOGLE_PARTNER_PORTAL_CLIENTS",
+ "GOOGLE_PARTNER_PUBLIC_USER_PROFILE",
+ "GOOGLE_PARTNER_PANEL",
+ "GOOGLE_PARTNER_PORTAL_LAST_ADMIN_DIALOG",
+ "GOOGLE_PARTNER_CLIENT",
+ "GOOGLE_PARTNER_PORTAL_COMPANY_PROFILE",
+ "EXTERNAL_LINKS",
+ "GOOGLE_PARTNER_LANDING"
+ ]
+ },
+ "lead": {
+ "$ref": "Lead",
+ "description": "Advertiser lead information."
}
},
"id": "LogUserEventRequest"
},
+ "UserOverrides": {
+ "type": "object",
+ "properties": {
+ "userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ }
+ },
+ "id": "UserOverrides",
+ "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products."
+ },
"AnalyticsDataPoint": {
+ "id": "AnalyticsDataPoint",
"description": "Details of the analytics events for a `Company` within a single day.",
"type": "object",
"properties": {
+ "eventCount": {
+ "format": "int32",
+ "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
+ "type": "integer"
+ },
"eventLocations": {
"items": {
"$ref": "LatLng"
},
"type": "array",
"description": "Location information of where these events occurred."
- },
- "eventCount": {
- "format": "int32",
- "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
- "type": "integer"
}
- },
- "id": "AnalyticsDataPoint"
+ }
},
"Analytics": {
- "description": "Analytics data for a `Company` within a single day.",
- "type": "object",
"properties": {
+ "contacts": {
+ "description": "Instances of users contacting the `Company`\non the specified date.",
+ "$ref": "AnalyticsDataPoint"
+ },
"searchViews": {
"$ref": "AnalyticsDataPoint",
"description": "Instances of users seeing the `Company` in Google Partners Search results\non the specified date."
@@ -2982,19 +2673,15 @@
"description": "Instances of users viewing the `Company` profile\non the specified date."
},
"eventDate": {
- "description": "Date on which these events occurred.",
- "$ref": "Date"
- },
- "contacts": {
- "$ref": "AnalyticsDataPoint",
- "description": "Instances of users contacting the `Company`\non the specified date."
+ "$ref": "Date",
+ "description": "Date on which these events occurred."
}
},
- "id": "Analytics"
+ "id": "Analytics",
+ "description": "Analytics data for a `Company` within a single day.",
+ "type": "object"
},
"AdWordsManagerAccountInfo": {
- "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
- "type": "object",
"properties": {
"id": {
"format": "int64",
@@ -3006,34 +2693,36 @@
"type": "string"
}
},
- "id": "AdWordsManagerAccountInfo"
+ "id": "AdWordsManagerAccountInfo",
+ "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
+ "type": "object"
},
"PublicProfile": {
- "description": "Basic information from a public profile.",
- "type": "object",
"properties": {
- "profileImage": {
- "type": "string",
- "description": "The URL to the main profile image of the public profile."
- },
- "displayImageUrl": {
- "type": "string",
- "description": "The URL to the main display image of the public profile. Being deprecated."
- },
- "displayName": {
- "description": "The display name of the public profile.",
- "type": "string"
- },
"url": {
- "description": "The URL of the public profile.",
- "type": "string"
+ "type": "string",
+ "description": "The URL of the public profile."
},
"id": {
- "description": "The ID which can be used to retrieve more details about the public profile.",
+ "type": "string",
+ "description": "The ID which can be used to retrieve more details about the public profile."
+ },
+ "profileImage": {
+ "description": "The URL to the main profile image of the public profile.",
"type": "string"
+ },
+ "displayImageUrl": {
+ "description": "The URL to the main display image of the public profile. Being deprecated.",
+ "type": "string"
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The display name of the public profile."
}
},
- "id": "PublicProfile"
+ "id": "PublicProfile",
+ "description": "Basic information from a public profile.",
+ "type": "object"
},
"ResponseMetadata": {
"description": "Common data that is in each API response.",
@@ -3047,26 +2736,47 @@
"id": "ResponseMetadata"
},
"RecaptchaChallenge": {
- "id": "RecaptchaChallenge",
"description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
"type": "object",
"properties": {
- "response": {
- "description": "The response to the reCaptcha challenge.",
- "type": "string"
- },
"id": {
"description": "The ID of the reCaptcha challenge.",
"type": "string"
+ },
+ "response": {
+ "description": "The response to the reCaptcha challenge.",
+ "type": "string"
}
- }
+ },
+ "id": "RecaptchaChallenge"
},
"AvailableOffer": {
- "id": "AvailableOffer",
"description": "Available Offers to be distributed.",
"type": "object",
"properties": {
+ "id": {
+ "type": "string",
+ "format": "int64",
+ "description": "ID of this offer."
+ },
+ "qualifiedCustomersComplete": {
+ "description": "Whether or not the list of qualified customers is definitely complete.",
+ "type": "boolean"
+ },
+ "countryOfferInfos": {
+ "description": "Offer info by country.",
+ "items": {
+ "$ref": "CountryOfferInfo"
+ },
+ "type": "array"
+ },
"offerType": {
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
"enum": [
"OFFER_TYPE_UNSPECIFIED",
"OFFER_TYPE_SPEND_X_GET_Y",
@@ -3074,13 +2784,7 @@
"OFFER_TYPE_SPEND_MATCH"
],
"description": "Type of offer.",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ]
+ "type": "string"
},
"maxAccountAge": {
"format": "int32",
@@ -3138,49 +2842,30 @@
"name": {
"description": "Name of the offer.",
"type": "string"
- },
- "qualifiedCustomersComplete": {
- "description": "Whether or not the list of qualified customers is definitely complete.",
- "type": "boolean"
- },
- "id": {
- "type": "string",
- "format": "int64",
- "description": "ID of this offer."
- },
- "countryOfferInfos": {
- "description": "Offer info by country.",
- "items": {
- "$ref": "CountryOfferInfo"
- },
- "type": "array"
}
- }
+ },
+ "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)",
"type": "object",
"properties": {
- "latitude": {
- "type": "number",
- "format": "double",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0]."
- },
"longitude": {
"format": "double",
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"type": "number"
+ },
+ "latitude": {
+ "type": "number",
+ "format": "double",
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0]."
}
},
"id": "LatLng"
},
"Money": {
+ "type": "object",
"properties": {
- "units": {
- "format": "int64",
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "type": "string"
- },
"currencyCode": {
"description": "The 3-letter currency code defined in ISO 4217.",
"type": "string"
@@ -3189,11 +2874,15 @@
"format": "int32",
"description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
"type": "integer"
+ },
+ "units": {
+ "format": "int64",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "type": "string"
}
},
"id": "Money",
- "description": "Represents an amount of money with its currency type.",
- "type": "object"
+ "description": "Represents an amount of money with its currency type."
},
"AnalyticsSummary": {
"description": "Analytics aggregated data for a `Company` for a given date range.",
@@ -3218,20 +2907,10 @@
"id": "AnalyticsSummary"
},
"LogMessageRequest": {
+ "description": "Request message for\nLogClientMessage.",
+ "type": "object",
"properties": {
- "clientInfo": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
- "type": "object"
- },
- "requestMetadata": {
- "description": "Current request metadata.",
- "$ref": "RequestMetadata"
- },
"level": {
- "description": "Message level of client message.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
@@ -3246,18 +2925,30 @@
"ML_INFO",
"ML_WARNING",
"ML_SEVERE"
- ]
+ ],
+ "description": "Message level of client message."
},
"details": {
"description": "Details about the client message.",
"type": "string"
+ },
+ "clientInfo": {
+ "description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
}
},
- "id": "LogMessageRequest",
- "description": "Request message for\nLogClientMessage.",
- "type": "object"
+ "id": "LogMessageRequest"
},
"Lead": {
+ "id": "Lead",
+ "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).",
"type": "object",
"properties": {
"adwordsCustomerId": {
@@ -3279,15 +2970,15 @@
"type": "boolean"
},
"type": {
- "enum": [
- "LEAD_TYPE_UNSPECIFIED",
- "LT_GPS"
- ],
"description": "Type of lead.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
"Google Partner Search."
+ ],
+ "enum": [
+ "LEAD_TYPE_UNSPECIFIED",
+ "LT_GPS"
]
},
"givenName": {
@@ -3295,8 +2986,8 @@
"type": "string"
},
"minMonthlyBudget": {
- "$ref": "Money",
- "description": "The minimum monthly budget lead source is willing to spend."
+ "description": "The minimum monthly budget lead source is willing to spend.",
+ "$ref": "Money"
},
"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\").",
@@ -3325,13 +3016,6 @@
"description": "The lead's state in relation to the company."
},
"gpsMotivations": {
- "enumDescriptions": [
- "Unchosen.",
- "Advertiser needs help with their advertising.",
- "Advertiser needs help with their website.",
- "Advertiser does not have a website."
- ],
- "description": "List of reasons for using Google Partner Search and creating a lead.",
"items": {
"enum": [
"GPS_MOTIVATION_UNSPECIFIED",
@@ -3341,15 +3025,22 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Advertiser needs help with their advertising.",
+ "Advertiser needs help with their website.",
+ "Advertiser does not have a website."
+ ],
+ "description": "List of reasons for using Google Partner Search and creating a lead."
},
"email": {
"description": "Email address of lead source.",
"type": "string"
},
"familyName": {
- "description": "Last name of lead source.",
- "type": "string"
+ "type": "string",
+ "description": "Last name of lead source."
},
"comments": {
"description": "Comments lead source gave.",
@@ -3359,9 +3050,7 @@
"description": "ID of the lead.",
"type": "string"
}
- },
- "id": "Lead",
- "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal)."
+ }
},
"DebugInfo": {
"description": "Debug information about this request.",
@@ -3376,8 +3065,8 @@
"type": "string"
},
"serviceUrl": {
- "description": "URL of the service that handled this request.",
- "type": "string"
+ "type": "string",
+ "description": "URL of the service that handled this request."
}
},
"id": "DebugInfo"
@@ -3386,6 +3075,10 @@
"description": "Response message for\nListUserStates.",
"type": "object",
"properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
"userStates": {
"description": "User's states.",
"items": {
@@ -3400,57 +3093,23 @@
"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"
},
"CompanyRelation": {
- "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
"type": "object",
"properties": {
- "state": {
- "enumDescriptions": [
- "Default unspecified value.",
- "User has filled in a request to be associated with an company.\nNow waiting email confirmation.",
- "Pending approval from company.\nEmail confirmation will not approve this one.",
- "Approved by company."
- ],
- "enum": [
- "USER_COMPANY_REATION_STATE_NONE_SPECIFIED",
- "USER_COMPANY_RELATION_STATE_AWAIT_EMAIL",
- "USER_COMPANY_RELATION_STATE_AWAIT_ADMIN",
- "USER_COMPANY_RELATION_STATE_APPROVED"
- ],
- "description": "The state of relationship, in terms of approvals.",
- "type": "string"
- },
- "primaryAddress": {
- "description": "The primary location of the company.",
- "$ref": "Location"
- },
- "managerAccount": {
- "format": "int64",
- "description": "The AdWords manager account # associated this company.",
- "type": "string"
- },
- "name": {
- "description": "The name (in the company's primary language) for the company.",
- "type": "string"
- },
"segment": {
"description": "The segment the company is classified as.",
"items": {
- "type": "string",
"enum": [
"COMPANY_SEGMENT_UNKNOWN",
"COMPANY_SEGMENT_NAL",
"COMPANY_SEGMENT_PSP",
"COMPANY_SEGMENT_PPSP"
- ]
+ ],
+ "type": "string"
},
"type": "array",
"enumDescriptions": [
@@ -3472,18 +3131,18 @@
"type": "array"
},
"badgeTier": {
- "enum": [
- "BADGE_TIER_NONE",
- "BADGE_TIER_REGULAR",
- "BADGE_TIER_PREMIER"
- ],
- "description": "Whether the company is a Partner.",
"type": "string",
"enumDescriptions": [
"Tier badge is not set.",
"Agency has regular partner badge.",
"Agency has premier badge."
- ]
+ ],
+ "enum": [
+ "BADGE_TIER_NONE",
+ "BADGE_TIER_REGULAR",
+ "BADGE_TIER_PREMIER"
+ ],
+ "description": "Whether the company is a Partner."
},
"website": {
"description": "The website URL for this company.",
@@ -3510,17 +3169,17 @@
"description": "A URL to a profile photo, e.g. a G+ profile photo."
},
"resolvedTimestamp": {
- "type": "string",
"format": "google-datetime",
- "description": "The timestamp when the user was approved.\n@OutputOnly"
+ "description": "The timestamp when the user was approved.\n@OutputOnly",
+ "type": "string"
},
"companyAdmin": {
"description": "Indicates if the user is an admin for this company.",
"type": "boolean"
},
"address": {
- "description": "The primary address for this company.",
- "type": "string"
+ "type": "string",
+ "description": "The primary address for this company."
},
"isPending": {
"description": "The flag that indicates if the company is pending verification.",
@@ -3530,13 +3189,41 @@
"format": "google-datetime",
"description": "The timestamp of when affiliation was requested.\n@OutputOnly",
"type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default unspecified value.",
+ "User has filled in a request to be associated with an company.\nNow waiting email confirmation.",
+ "Pending approval from company.\nEmail confirmation will not approve this one.",
+ "Approved by company."
+ ],
+ "enum": [
+ "USER_COMPANY_REATION_STATE_NONE_SPECIFIED",
+ "USER_COMPANY_RELATION_STATE_AWAIT_EMAIL",
+ "USER_COMPANY_RELATION_STATE_AWAIT_ADMIN",
+ "USER_COMPANY_RELATION_STATE_APPROVED"
+ ],
+ "description": "The state of relationship, in terms of approvals."
+ },
+ "primaryAddress": {
+ "$ref": "Location",
+ "description": "The primary location of the company."
+ },
+ "managerAccount": {
+ "format": "int64",
+ "description": "The AdWords manager account # associated this company.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (in the company's primary language) for the company.",
+ "type": "string"
}
},
- "id": "CompanyRelation"
+ "id": "CompanyRelation",
+ "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners."
},
"Date": {
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object",
"properties": {
"day": {
"format": "int32",
@@ -3554,7 +3241,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 `{}`.",
@@ -3563,17 +3252,36 @@
"id": "Empty"
},
"TrafficSource": {
- "id": "TrafficSource",
"description": "Source of traffic for the current request.",
"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."
- },
"trafficSubId": {
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
+ },
+ "trafficSourceId": {
+ "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"
+ }
+ },
+ "id": "TrafficSource"
+ },
+ "CreateLeadRequest": {
+ "id": "CreateLeadRequest",
+ "description": "Request message for CreateLead.",
+ "type": "object",
+ "properties": {
+ "recaptchaChallenge": {
+ "$ref": "RecaptchaChallenge",
+ "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info."
+ },
+ "lead": {
+ "$ref": "Lead",
+ "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided."
+ },
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
}
}
},
@@ -3594,45 +3302,337 @@
"description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products."
},
"trafficSource": {
- "$ref": "TrafficSource",
- "description": "Source of traffic for the current request."
+ "description": "Source of traffic for the current request.",
+ "$ref": "TrafficSource"
},
"experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "Experiment IDs the current request belongs to."
+ "type": "array"
}
},
"id": "RequestMetadata"
},
- "CreateLeadRequest": {
- "id": "CreateLeadRequest",
- "description": "Request message for CreateLead.",
+ "EventData": {
+ "id": "EventData",
+ "description": "Key value data pair for an event.",
"type": "object",
"properties": {
- "requestMetadata": {
- "description": "Current request metadata.",
- "$ref": "RequestMetadata"
+ "values": {
+ "description": "Data values.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
},
- "recaptchaChallenge": {
- "$ref": "RecaptchaChallenge",
- "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info."
- },
- "lead": {
- "$ref": "Lead",
- "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided."
+ "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."
}
}
+ },
+ "ExamStatus": {
+ "description": "A user's information on a specific exam.",
+ "type": "object",
+ "properties": {
+ "passed": {
+ "description": "Whether this exam has been passed and not expired.",
+ "type": "boolean"
+ },
+ "taken": {
+ "format": "google-datetime",
+ "description": "The date the user last taken this exam.",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Whether this exam is in the state of warning.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "format": "google-datetime",
+ "description": "Date this exam is due to expire.",
+ "type": "string"
+ },
+ "lastPassed": {
+ "format": "google-datetime",
+ "description": "The date the user last passed this exam.",
+ "type": "string"
+ },
+ "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": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "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.",
+ "items": {
+ "$ref": "AvailableOffer"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListOffersResponse"
+ },
+ "CountryOfferInfo": {
+ "id": "CountryOfferInfo",
+ "description": "Offer info by country.",
+ "type": "object",
+ "properties": {
+ "offerType": {
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of offer country is eligible for.",
+ "type": "string"
+ },
+ "getYAmount": {
+ "description": "(localized) Get Y amount for that country's offer.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "description": "(localized) Spend X amount for that country's offer.",
+ "type": "string"
+ },
+ "offerCountryCode": {
+ "description": "Country code for which offer codes may be requested.",
+ "type": "string"
+ }
+ }
+ },
+ "ListCompaniesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ },
+ "companies": {
+ "description": "The list of companies.",
+ "items": {
+ "$ref": "Company"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListCompaniesResponse",
+ "description": "Response message for\nListCompanies.",
+ "type": "object"
+ },
+ "OfferCustomer": {
+ "properties": {
+ "name": {
+ "description": "Name of the customer.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "description": "Formatted Spend X amount with currency code.",
+ "type": "string"
+ },
+ "adwordsUrl": {
+ "description": "URL to the customer's AdWords page.",
+ "type": "string"
+ },
+ "creationTime": {
+ "format": "google-datetime",
+ "description": "Time the customer was created.",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country code of the customer.",
+ "type": "string"
+ },
+ "eligibilityDaysLeft": {
+ "format": "int32",
+ "description": "Days the customer is still eligible.",
+ "type": "integer"
+ },
+ "offerType": {
+ "description": "Type of the offer",
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ]
+ },
+ "externalCid": {
+ "format": "int64",
+ "description": "External CID for the customer.",
+ "type": "string"
+ },
+ "getYAmount": {
+ "description": "Formatted Get Y amount with currency code.",
+ "type": "string"
+ }
+ },
+ "id": "OfferCustomer",
+ "description": "Customers qualified for an offer.",
+ "type": "object"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"version": "v2",
"baseUrl": "https://partners.googleapis.com/",
- "canonicalName": "Partners"
+ "canonicalName": "Partners",
+ "servicePath": "",
+ "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://partners.googleapis.com/"
}
diff --git a/people/v1/people-api.json b/people/v1/people-api.json
index bfad2e7..e86e664 100644
--- a/people/v1/people-api.json
+++ b/people/v1/people-api.json
@@ -1,924 +1,51 @@
{
- "version": "v1",
- "baseUrl": "https://people.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Provides access to information about profiles and contacts.",
- "servicePath": "",
- "basePath": "",
- "id": "people:v1",
- "revision": "20170822",
+ "revision": "20170823",
"documentationLink": "https://developers.google.com/people/",
+ "id": "people:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ContactGroupResponse": {
- "description": "The response for a specific contact group.",
- "type": "object",
- "properties": {
- "requestedResourceName": {
- "description": "The original requested resource name.",
- "type": "string"
- },
- "contactGroup": {
- "description": "The contact group.",
- "$ref": "ContactGroup"
- },
- "status": {
- "description": "The status of the response.",
- "$ref": "Status"
- }
- },
- "id": "ContactGroupResponse"
- },
- "Url": {
- "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": {
- "description": "Metadata about the URL.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The URL.",
- "type": "string"
- },
- "formattedType": {
- "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- }
- },
- "id": "Url",
- "description": "A person's associated URLs.",
- "type": "object"
- },
- "ImClient": {
- "description": "A person's instant messaging client.",
- "type": "object",
- "properties": {
- "protocol": {
- "description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\n* `icq`\n* `jabber`\n* `netMeeting`",
- "type": "string"
- },
- "metadata": {
- "$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"
- },
- "username": {
- "description": "The user name used in the IM client.",
- "type": "string"
- },
- "formattedProtocol": {
- "description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "formattedType": {
- "description": "The read-only type of the IM client translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- }
- },
- "id": "ImClient"
- },
- "DomainMembership": {
- "description": "A Google Apps Domain membership.",
- "type": "object",
- "properties": {
- "inViewerDomain": {
- "description": "True if the person is in the viewer's Google Apps domain.",
- "type": "boolean"
- }
- },
- "id": "DomainMembership"
- },
- "Membership": {
- "description": "A person's read-only membership in a group.",
- "type": "object",
- "properties": {
- "domainMembership": {
- "$ref": "DomainMembership",
- "description": "The domain membership."
- },
- "contactGroupMembership": {
- "description": "The contact group membership.",
- "$ref": "ContactGroupMembership"
- },
- "metadata": {
- "description": "Metadata about the membership.",
- "$ref": "FieldMetadata"
- }
- },
- "id": "Membership"
- },
- "BatchGetContactGroupsResponse": {
- "properties": {
- "responses": {
- "description": "The list of responses for each requested contact group resource.",
- "items": {
- "$ref": "ContactGroupResponse"
- },
- "type": "array"
- }
- },
- "id": "BatchGetContactGroupsResponse",
- "description": "The response to a batch get contact groups request.",
- "type": "object"
- },
- "RelationshipStatus": {
- "properties": {
- "formattedValue": {
- "description": "The read-only value of the relationship status translated and formatted in\nthe viewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the relationship status.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
- "type": "string"
- }
- },
- "id": "RelationshipStatus",
- "description": "A person's read-only relationship status.",
- "type": "object"
- },
- "BraggingRights": {
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the bragging rights."
- },
- "value": {
- "description": "The bragging rights; for example, `climbed mount everest`.",
- "type": "string"
- }
- },
- "id": "BraggingRights",
- "description": "A person's bragging rights.",
- "type": "object"
- },
- "Organization": {
- "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
- "type": "object",
- "properties": {
- "startDate": {
- "$ref": "Date",
- "description": "The start date when the person joined the organization."
- },
- "formattedType": {
- "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "domain": {
- "description": "The domain name associated with the organization; for example, `google.com`.",
- "type": "string"
- },
- "department": {
- "description": "The person's department at the organization.",
- "type": "string"
- },
- "type": {
- "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
- "type": "string"
- },
- "phoneticName": {
- "description": "The phonetic name of the organization.",
- "type": "string"
- },
- "jobDescription": {
- "description": "The person's job description at the organization.",
- "type": "string"
- },
- "endDate": {
- "$ref": "Date",
- "description": "The end date when the person left the organization."
- },
- "symbol": {
- "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
- "type": "string"
- },
- "name": {
- "description": "The name of the organization.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the organization.",
- "$ref": "FieldMetadata"
- },
- "location": {
- "description": "The location of the organization office the person works at.",
- "type": "string"
- },
- "title": {
- "description": "The person's job title at the organization.",
- "type": "string"
- },
- "current": {
- "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
- "type": "boolean"
- }
- },
- "id": "Organization"
- },
- "AgeRangeType": {
- "description": "A person's age range.",
- "type": "object",
- "properties": {
- "ageRange": {
- "enumDescriptions": [
- "Unspecified.",
- "Younger than eighteen.",
- "Between eighteen and twenty.",
- "Twenty-one and older."
- ],
- "enum": [
- "AGE_RANGE_UNSPECIFIED",
- "LESS_THAN_EIGHTEEN",
- "EIGHTEEN_TO_TWENTY",
- "TWENTY_ONE_OR_OLDER"
- ],
- "description": "The age range.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the age range."
- }
- },
- "id": "AgeRangeType"
- },
- "ListContactGroupsResponse": {
- "description": "The response to a list contact groups request.",
- "type": "object",
- "properties": {
- "contactGroups": {
- "description": "The list of contact groups. Members of the contact groups are not\npopulated.",
- "items": {
- "$ref": "ContactGroup"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The token that can be used to retrieve the next page of results.",
- "type": "string"
- },
- "nextSyncToken": {
- "description": "The token that can be used to retrieve changes since the last request.",
- "type": "string"
- },
- "totalItems": {
- "format": "int32",
- "description": "The total number of items in the list without pagination.",
- "type": "integer"
- }
- },
- "id": "ListContactGroupsResponse"
- },
- "PersonResponse": {
- "description": "The response for a single person",
- "type": "object",
- "properties": {
- "httpStatusCode": {
- "format": "int32",
- "description": "**DEPRECATED** (Please use status instead)\n\n[HTTP 1.1 status code]\n(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": {
- "description": "The status of the response.",
- "$ref": "Status"
- }
- },
- "id": "PersonResponse"
- },
- "Relation": {
- "description": "A person's relation to another person.",
- "type": "object",
- "properties": {
- "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 relation.",
- "$ref": "FieldMetadata"
- },
- "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"
- }
- },
- "id": "Relation"
- },
- "Occupation": {
- "properties": {
- "metadata": {
- "description": "Metadata about the occupation.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The occupation; for example, `carpenter`.",
- "type": "string"
- }
- },
- "id": "Occupation",
- "description": "A person's occupation.",
- "type": "object"
- },
- "ContactGroup": {
- "description": "A contact group.",
- "type": "object",
- "properties": {
- "resourceName": {
- "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
- "type": "string"
- },
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
- "type": "string"
- },
- "groupType": {
- "description": "The read-only contact group type.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "User defined contact group.",
- "System defined contact group."
- ],
- "enum": [
- "GROUP_TYPE_UNSPECIFIED",
- "USER_CONTACT_GROUP",
- "SYSTEM_CONTACT_GROUP"
- ]
- },
- "formattedName": {
- "description": "The read-only name translated and formatted in the viewer's account locale\nor the `Accept-Language` HTTP header locale for system groups names.\nGroup names set by the owner are the same as name.",
- "type": "string"
- },
- "memberResourceNames": {
- "description": "The list of contact person resource names that are members of the contact\ngroup. The field is not populated for LIST requests and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
- "type": "string"
- },
- "metadata": {
- "$ref": "ContactGroupMetadata",
- "description": "Metadata about the contact group."
- },
- "memberCount": {
- "format": "int32",
- "description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
- "type": "integer"
- }
- },
- "id": "ContactGroup"
- },
- "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": {
- "resourceName": {
- "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
- "type": "string"
- },
- "interests": {
- "description": "The person's interests.",
- "items": {
- "$ref": "Interest"
- },
- "type": "array"
- },
- "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 read-only relationship statuses.",
- "items": {
- "$ref": "RelationshipStatus"
- },
- "type": "array"
- },
- "photos": {
- "description": "The person's read-only photos.",
- "items": {
- "$ref": "Photo"
- },
- "type": "array"
- },
- "ageRange": {
- "description": "**DEPRECATED** (Please use `person.ageRanges` instead)**\n\nThe person's read-only 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 read-only taglines.",
- "items": {
- "$ref": "Tagline"
- },
- "type": "array"
- },
- "ageRanges": {
- "description": "The person's read-only age ranges.",
- "items": {
- "$ref": "AgeRangeType"
- },
- "type": "array"
- },
- "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 read-only group memberships.",
- "items": {
- "$ref": "Membership"
- },
- "type": "array"
- },
- "phoneNumbers": {
- "description": "The person's phone numbers.",
- "items": {
- "$ref": "PhoneNumber"
- },
- "type": "array"
- },
- "coverPhotos": {
- "description": "The person's read-only cover photos.",
- "items": {
- "$ref": "CoverPhoto"
- },
- "type": "array"
- },
- "imClients": {
- "description": "The person's instant messaging clients.",
- "items": {
- "$ref": "ImClient"
- },
- "type": "array"
- },
- "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 person's read-only relationship interests.g4",
- "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": {
- "description": "The person's email addresses.",
- "items": {
- "$ref": "EmailAddress"
- },
- "type": "array"
- },
- "organizations": {
- "description": "The person's past or current organizations.",
- "items": {
- "$ref": "Organization"
- },
- "type": "array"
- },
- "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.",
- "items": {
- "$ref": "BraggingRights"
- },
- "type": "array"
- },
- "metadata": {
- "description": "Read-only metadata about the person.",
- "$ref": "PersonMetadata"
- },
- "residences": {
- "description": "The person's residences.",
- "items": {
- "$ref": "Residence"
- },
- "type": "array"
- },
- "genders": {
- "description": "The person's genders.",
- "items": {
- "$ref": "Gender"
- },
- "type": "array"
- }
- },
- "id": "Person"
- },
- "UpdateContactGroupRequest": {
- "description": "A request to update an existing contact group. Only the name can be updated.",
- "type": "object",
- "properties": {
- "contactGroup": {
- "$ref": "ContactGroup",
- "description": "The contact group to update."
- }
- },
- "id": "UpdateContactGroupRequest"
- },
- "ContactGroupMetadata": {
- "description": "The read-only metadata about a contact group.",
- "type": "object",
- "properties": {
- "updateTime": {
- "format": "google-datetime",
- "description": "The time the group was last updated.",
- "type": "string"
- },
- "deleted": {
- "description": "True if the contact group resource has been deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests\nthat include a sync token.",
- "type": "boolean"
- }
- },
- "id": "ContactGroupMetadata"
- },
- "Residence": {
- "description": "A person's past or current residence.",
- "type": "object",
- "properties": {
- "current": {
- "description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
- "type": "boolean"
- },
- "metadata": {
- "description": "Metadata about the residence.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The address of the residence.",
- "type": "string"
- }
- },
- "id": "Residence"
- },
- "Event": {
- "description": "An event related to the person.",
- "type": "object",
- "properties": {
- "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"
- },
- "metadata": {
- "description": "Metadata about the event.",
- "$ref": "FieldMetadata"
- },
- "date": {
- "description": "The date of the event.",
- "$ref": "Date"
- },
- "formattedType": {
- "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- }
- },
- "id": "Event"
- },
- "ModifyContactGroupMembersResponse": {
- "properties": {
- "notFoundResourceNames": {
- "description": "The contact people resource names that were not found.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "ModifyContactGroupMembersResponse",
- "description": "The response to a modify contact group members request.",
- "type": "object"
- },
- "ProfileMetadata": {
- "description": "The read-only metadata about a profile.",
- "type": "object",
- "properties": {
- "userTypes": {
- "enumDescriptions": [
- "The user type is not known.",
- "The user is a Google user.",
- "The user is a Google+ user.",
- "The user is a Google Apps for Work user."
- ],
- "description": "The user types.",
- "items": {
- "enum": [
- "USER_TYPE_UNKNOWN",
- "GOOGLE_USER",
- "GPLUS_USER",
- "GOOGLE_APPS_USER"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "objectType": {
- "enumDescriptions": [
- "Unspecified.",
- "Person.",
- "[Google+ Page.](http://www.google.com/+/brands/)"
- ],
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ],
- "description": "The profile object type.",
- "type": "string"
- }
- },
- "id": "ProfileMetadata"
- },
- "Gender": {
- "description": "A person's gender.",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Metadata about the gender.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
- "type": "string"
- },
- "formattedValue": {
- "description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- }
- },
- "id": "Gender"
- },
- "CoverPhoto": {
- "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": {
- "description": "Metadata about the cover photo.",
- "$ref": "FieldMetadata"
- },
- "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.",
- "type": "object"
- },
- "Interest": {
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the interest."
- },
- "value": {
- "description": "The interest; for example, `stargazing`.",
- "type": "string"
- }
- },
- "id": "Interest",
- "description": "One of the person's interests.",
- "type": "object"
- },
- "EmailAddress": {
- "description": "A person's email address.",
- "type": "object",
- "properties": {
- "formattedType": {
- "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name of the email.",
- "type": "string"
- },
- "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"
- },
- "metadata": {
- "description": "Metadata about the email address.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The email address.",
- "type": "string"
- }
- },
- "id": "EmailAddress"
- },
- "Nickname": {
- "description": "A person's nickname.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The nickname.",
- "type": "string"
- },
- "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.`"
- ]
- },
- "metadata": {
- "description": "Metadata about the nickname.",
- "$ref": "FieldMetadata"
- }
- },
- "id": "Nickname"
- },
- "Skill": {
- "description": "A skill that the person has.",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Metadata about the skill.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The skill; for example, `underwater basket weaving`.",
- "type": "string"
- }
- },
- "id": "Skill"
- },
- "Tagline": {
- "description": "A read-only brief one-line description of the person.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the tagline."
- },
- "value": {
- "description": "The tagline.",
- "type": "string"
- }
- },
- "id": "Tagline"
- },
"Date": {
+ "id": "Date",
"description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.",
"type": "object",
"properties": {
- "day": {
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"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": {
+ "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",
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"type": "integer"
},
"month": {
- "format": "int32",
"description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
"type": "integer"
}
- },
- "id": "Date"
+ }
+ },
+ "Tagline": {
+ "id": "Tagline",
+ "description": "A read-only brief one-line description of the person.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The tagline.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the tagline.",
+ "$ref": "FieldMetadata"
+ }
+ }
},
"Name": {
"description": "A person's name. If the name is a mononym, the family name is empty.",
"type": "object",
"properties": {
- "honorificPrefix": {
- "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
- "type": "string"
- },
- "phoneticHonorificSuffix": {
- "description": "The honorific suffixes spelled as they sound.",
- "type": "string"
- },
- "givenName": {
- "description": "The given name.",
- "type": "string"
- },
- "middleName": {
- "description": "The middle name(s).",
- "type": "string"
- },
"phoneticHonorificPrefix": {
"description": "The honorific prefixes spelled as they sound.",
"type": "string"
@@ -958,6 +85,22 @@
"honorificSuffix": {
"description": "The honorific suffixes, such as `Jr.`",
"type": "string"
+ },
+ "honorificPrefix": {
+ "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
+ "type": "string"
+ },
+ "phoneticHonorificSuffix": {
+ "description": "The honorific suffixes spelled as they sound.",
+ "type": "string"
+ },
+ "middleName": {
+ "description": "The middle name(s).",
+ "type": "string"
+ },
+ "givenName": {
+ "description": "The given name.",
+ "type": "string"
}
},
"id": "Name"
@@ -966,27 +109,31 @@
"description": "A person's locale preference.",
"type": "object",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the locale."
- },
"value": {
"description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
"type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the locale."
}
},
"id": "Locale"
},
"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": {}
},
"Biography": {
"description": "A person's short biography.",
"type": "object",
"properties": {
+ "value": {
+ "description": "The short biography.",
+ "type": "string"
+ },
"contentType": {
"description": "The content type of the biography.",
"type": "string",
@@ -1004,10 +151,6 @@
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the biography."
- },
- "value": {
- "description": "The short biography.",
- "type": "string"
}
},
"id": "Biography"
@@ -1032,32 +175,29 @@
"id": "FieldMetadata"
},
"RelationshipInterest": {
+ "id": "RelationshipInterest",
"description": "A person's read-only relationship interest .",
"type": "object",
"properties": {
- "formattedValue": {
- "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
- "type": "string"
- },
"metadata": {
- "description": "Metadata about the relationship interest.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relationship interest."
},
"value": {
"description": "The kind of relationship the person is looking for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
"type": "string"
+ },
+ "formattedValue": {
+ "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
+ "type": "string"
}
- },
- "id": "RelationshipInterest"
+ }
},
"Source": {
+ "id": "Source",
"description": "The source of a field.",
"type": "object",
"properties": {
- "etag": {
- "description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation.",
- "type": "string"
- },
"id": {
"description": "The unique identifier within the source type generated by the server.",
"type": "string"
@@ -1067,8 +207,8 @@
"$ref": "ProfileMetadata"
},
"updateTime": {
- "format": "google-datetime",
"description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
+ "format": "google-datetime",
"type": "string"
},
"type": {
@@ -1088,22 +228,40 @@
"DOMAIN_PROFILE",
"CONTACT"
]
+ },
+ "etag": {
+ "description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation.",
+ "type": "string"
}
- },
- "id": "Source"
+ }
},
"GetPeopleResponse": {
+ "id": "GetPeopleResponse",
+ "type": "object",
"properties": {
"responses": {
"description": "The response for each requested resource name.",
+ "type": "array",
"items": {
"$ref": "PersonResponse"
- },
- "type": "array"
+ }
}
- },
- "id": "GetPeopleResponse",
- "type": "object"
+ }
+ },
+ "Photo": {
+ "id": "Photo",
+ "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the photo.",
+ "$ref": "FieldMetadata"
+ },
+ "url": {
+ "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`\u003cvar\u003esize\u003c/var\u003e at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`",
+ "type": "string"
+ }
+ }
},
"PhoneNumber": {
"description": "A person's phone number.",
@@ -1121,109 +279,83 @@
"description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
"type": "string"
},
+ "metadata": {
+ "description": "Metadata about the phone number.",
+ "$ref": "FieldMetadata"
+ },
"type": {
"description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFax`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `other`",
"type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the phone number."
}
},
"id": "PhoneNumber"
},
- "Photo": {
- "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the photo."
- },
- "url": {
- "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`\u003cvar\u003esize\u003c/var\u003e at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`",
- "type": "string"
- }
- },
- "id": "Photo"
- },
"ListConnectionsResponse": {
+ "id": "ListConnectionsResponse",
"type": "object",
"properties": {
- "totalPeople": {
- "format": "int32",
- "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
- "type": "integer"
- },
- "nextPageToken": {
- "description": "The token that can be used to retrieve the next page of results.",
- "type": "string"
- },
- "totalItems": {
- "format": "int32",
- "description": "The total number of items in the list without pagination.",
- "type": "integer"
+ "connections": {
+ "description": "The list of people that the requestor is connected to.",
+ "type": "array",
+ "items": {
+ "$ref": "Person"
+ }
},
"nextSyncToken": {
"description": "The token that can be used to retrieve changes since the last request.",
"type": "string"
},
- "connections": {
- "description": "The list of people that the requestor is connected to.",
- "items": {
- "$ref": "Person"
- },
- "type": "array"
+ "totalItems": {
+ "description": "The total number of items in the list without pagination.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalPeople": {
+ "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nextPageToken": {
+ "description": "The token that can be used to retrieve the next page of results.",
+ "type": "string"
}
- },
- "id": "ListConnectionsResponse"
+ }
},
"Birthday": {
+ "id": "Birthday",
+ "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.",
+ "type": "object",
"properties": {
- "date": {
- "$ref": "Date",
- "description": "The date of the birthday."
+ "metadata": {
+ "description": "Metadata about the birthday.",
+ "$ref": "FieldMetadata"
},
"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.",
- "type": "object"
+ }
},
"CreateContactGroupRequest": {
+ "id": "CreateContactGroupRequest",
"description": "A request to create a new contact group.",
"type": "object",
"properties": {
"contactGroup": {
- "description": "The contact group to create.",
- "$ref": "ContactGroup"
+ "$ref": "ContactGroup",
+ "description": "The contact group to create."
}
- },
- "id": "CreateContactGroupRequest"
+ }
},
"Address": {
+ "id": "Address",
"description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
"type": "object",
"properties": {
- "region": {
- "description": "The region of the address; for example, the state or province.",
- "type": "string"
- },
- "streetAddress": {
- "description": "The street address.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the address.",
- "$ref": "FieldMetadata"
- },
"countryCode": {
"description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
"type": "string"
@@ -1259,36 +391,20 @@
"postalCode": {
"description": "The postal code of the address.",
"type": "string"
- }
- },
- "id": "Address"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
},
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "region": {
+ "description": "The region of the address; for example, the state or province.",
"type": "string"
+ },
+ "streetAddress": {
+ "description": "The street address.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the address.",
+ "$ref": "FieldMetadata"
}
- },
- "id": "Status"
+ }
},
"ContactGroupMembership": {
"description": "A Google contact group membership.",
@@ -1301,44 +417,71 @@
},
"id": "ContactGroupMembership"
},
+ "Status": {
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ }
+ }
+ },
"PersonMetadata": {
"description": "The read-only metadata about a person.",
"type": "object",
"properties": {
"objectType": {
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ],
"description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
"Person.",
"[Google+ Page.](http://www.google.com/+/brands/)"
+ ],
+ "enum": [
+ "OBJECT_TYPE_UNSPECIFIED",
+ "PERSON",
+ "PAGE"
]
},
"linkedPeopleResourceNames": {
"description": "Resource names of people linked to this resource.",
+ "type": "array",
"items": {
"type": "string"
- },
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ }
},
"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"
+ }
},
"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.",
@@ -1353,43 +496,894 @@
"properties": {
"resourceNamesToAdd": {
"description": "The resource names of the contact people to add in the form of in the form\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "type": "array",
"items": {
"type": "string"
- },
- "type": "array"
+ }
},
"resourceNamesToRemove": {
"description": "The resource names of the contact people to remove in the form of in the\nform of `people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "type": "array",
"items": {
"type": "string"
- },
- "type": "array"
+ }
}
},
"id": "ModifyContactGroupMembersRequest"
+ },
+ "ContactGroupResponse": {
+ "id": "ContactGroupResponse",
+ "description": "The response for a specific contact group.",
+ "type": "object",
+ "properties": {
+ "requestedResourceName": {
+ "description": "The original requested resource name.",
+ "type": "string"
+ },
+ "contactGroup": {
+ "description": "The contact group.",
+ "$ref": "ContactGroup"
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "The status of the response."
+ }
+ }
+ },
+ "Url": {
+ "id": "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"
+ }
+ }
+ },
+ "ImClient": {
+ "description": "A person's instant messaging client.",
+ "type": "object",
+ "properties": {
+ "formattedProtocol": {
+ "description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "formattedType": {
+ "description": "The read-only type of the IM client translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the IM client.",
+ "$ref": "FieldMetadata"
+ },
+ "type": {
+ "description": "The type of the IM client. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
+ "type": "string"
+ },
+ "protocol": {
+ "description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\n* `icq`\n* `jabber`\n* `netMeeting`",
+ "type": "string"
+ },
+ "username": {
+ "description": "The user name used in the IM client.",
+ "type": "string"
+ }
+ },
+ "id": "ImClient"
+ },
+ "DomainMembership": {
+ "id": "DomainMembership",
+ "description": "A Google Apps Domain membership.",
+ "type": "object",
+ "properties": {
+ "inViewerDomain": {
+ "description": "True if the person is in the viewer's Google Apps domain.",
+ "type": "boolean"
+ }
+ }
+ },
+ "Membership": {
+ "id": "Membership",
+ "description": "A person's read-only membership in a group.",
+ "type": "object",
+ "properties": {
+ "contactGroupMembership": {
+ "$ref": "ContactGroupMembership",
+ "description": "The contact group membership."
+ },
+ "domainMembership": {
+ "$ref": "DomainMembership",
+ "description": "The domain membership."
+ },
+ "metadata": {
+ "description": "Metadata about the membership.",
+ "$ref": "FieldMetadata"
+ }
+ }
+ },
+ "BatchGetContactGroupsResponse": {
+ "description": "The response to a batch get contact groups request.",
+ "type": "object",
+ "properties": {
+ "responses": {
+ "description": "The list of responses for each requested contact group resource.",
+ "type": "array",
+ "items": {
+ "$ref": "ContactGroupResponse"
+ }
+ }
+ },
+ "id": "BatchGetContactGroupsResponse"
+ },
+ "RelationshipStatus": {
+ "id": "RelationshipStatus",
+ "description": "A person's read-only relationship status.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relationship status."
+ },
+ "value": {
+ "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "BraggingRights": {
+ "id": "BraggingRights",
+ "description": "A person's bragging rights.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the bragging rights.",
+ "$ref": "FieldMetadata"
+ },
+ "value": {
+ "description": "The bragging rights; for example, `climbed mount everest`.",
+ "type": "string"
+ }
+ }
+ },
+ "Organization": {
+ "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
+ "type": "object",
+ "properties": {
+ "startDate": {
+ "description": "The start date when the person joined the organization.",
+ "$ref": "Date"
+ },
+ "formattedType": {
+ "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "The domain name associated with the organization; for example, `google.com`.",
+ "type": "string"
+ },
+ "department": {
+ "description": "The person's department at the organization.",
+ "type": "string"
+ },
+ "phoneticName": {
+ "description": "The phonetic name of the organization.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
+ "type": "string"
+ },
+ "jobDescription": {
+ "description": "The person's job description at the organization.",
+ "type": "string"
+ },
+ "endDate": {
+ "description": "The end date when the person left the organization.",
+ "$ref": "Date"
+ },
+ "symbol": {
+ "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the organization.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the organization."
+ },
+ "location": {
+ "description": "The location of the organization office the person works at.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The person's job title at the organization.",
+ "type": "string"
+ },
+ "current": {
+ "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
+ "type": "boolean"
+ }
+ },
+ "id": "Organization"
+ },
+ "AgeRangeType": {
+ "id": "AgeRangeType",
+ "description": "A person's age range.",
+ "type": "object",
+ "properties": {
+ "ageRange": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Younger than eighteen.",
+ "Between eighteen and twenty.",
+ "Twenty-one and older."
+ ],
+ "enum": [
+ "AGE_RANGE_UNSPECIFIED",
+ "LESS_THAN_EIGHTEEN",
+ "EIGHTEEN_TO_TWENTY",
+ "TWENTY_ONE_OR_OLDER"
+ ],
+ "description": "The age range.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the age range.",
+ "$ref": "FieldMetadata"
+ }
+ }
+ },
+ "ListContactGroupsResponse": {
+ "id": "ListContactGroupsResponse",
+ "description": "The response to a list contact groups request.",
+ "type": "object",
+ "properties": {
+ "totalItems": {
+ "description": "The total number of items in the list without pagination.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nextSyncToken": {
+ "description": "The token that can be used to retrieve changes since the last request.",
+ "type": "string"
+ },
+ "contactGroups": {
+ "description": "The list of contact groups. Members of the contact groups are not\npopulated.",
+ "type": "array",
+ "items": {
+ "$ref": "ContactGroup"
+ }
+ },
+ "nextPageToken": {
+ "description": "The token that can be used to retrieve the next page of results.",
+ "type": "string"
+ }
+ }
+ },
+ "PersonResponse": {
+ "id": "PersonResponse",
+ "description": "The response for a single person",
+ "type": "object",
+ "properties": {
+ "person": {
+ "description": "The person.",
+ "$ref": "Person"
+ },
+ "status": {
+ "description": "The status of the response.",
+ "$ref": "Status"
+ },
+ "httpStatusCode": {
+ "description": "**DEPRECATED** (Please use status instead)\n\n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
+ "format": "int32",
+ "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"
+ }
+ }
+ },
+ "Relation": {
+ "description": "A person's relation to another person.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relation."
+ },
+ "type": {
+ "description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`",
+ "type": "string"
+ },
+ "person": {
+ "description": "The name of the other person this relation refers to.",
+ "type": "string"
+ },
+ "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"
+ },
+ "Occupation": {
+ "id": "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"
+ }
+ }
+ },
+ "ContactGroup": {
+ "id": "ContactGroup",
+ "description": "A contact group.",
+ "type": "object",
+ "properties": {
+ "resourceName": {
+ "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
+ "type": "string"
+ },
+ "formattedName": {
+ "description": "The read-only name translated and formatted in the viewer's account locale\nor the `Accept-Language` HTTP header locale for system groups names.\nGroup names set by the owner are the same as name.",
+ "type": "string"
+ },
+ "groupType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "User defined contact group.",
+ "System defined contact group."
+ ],
+ "enum": [
+ "GROUP_TYPE_UNSPECIFIED",
+ "USER_CONTACT_GROUP",
+ "SYSTEM_CONTACT_GROUP"
+ ],
+ "description": "The read-only contact group type.",
+ "type": "string"
+ },
+ "memberResourceNames": {
+ "description": "The list of contact person resource names that are members of the contact\ngroup. The field is not populated for LIST requests and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the contact group.",
+ "$ref": "ContactGroupMetadata"
+ },
+ "memberCount": {
+ "description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "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": {
+ "relations": {
+ "description": "The person's relations.",
+ "type": "array",
+ "items": {
+ "$ref": "Relation"
+ }
+ },
+ "names": {
+ "description": "The person's names.",
+ "type": "array",
+ "items": {
+ "$ref": "Name"
+ }
+ },
+ "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": {
+ "description": "Read-only metadata about the person.",
+ "$ref": "PersonMetadata"
+ },
+ "residences": {
+ "description": "The person's residences.",
+ "type": "array",
+ "items": {
+ "$ref": "Residence"
+ }
+ },
+ "genders": {
+ "description": "The person's genders.",
+ "type": "array",
+ "items": {
+ "$ref": "Gender"
+ }
+ },
+ "interests": {
+ "description": "The person's interests.",
+ "type": "array",
+ "items": {
+ "$ref": "Interest"
+ }
+ },
+ "resourceName": {
+ "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "type": "string"
+ },
+ "biographies": {
+ "description": "The person's biographies.",
+ "type": "array",
+ "items": {
+ "$ref": "Biography"
+ }
+ },
+ "skills": {
+ "description": "The person's skills.",
+ "type": "array",
+ "items": {
+ "$ref": "Skill"
+ }
+ },
+ "relationshipStatuses": {
+ "description": "The person's read-only relationship statuses.",
+ "type": "array",
+ "items": {
+ "$ref": "RelationshipStatus"
+ }
+ },
+ "photos": {
+ "description": "The person's read-only photos.",
+ "type": "array",
+ "items": {
+ "$ref": "Photo"
+ }
+ },
+ "ageRange": {
+ "description": "**DEPRECATED** (Please use `person.ageRanges` instead)**\n\nThe person's read-only 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 read-only taglines.",
+ "type": "array",
+ "items": {
+ "$ref": "Tagline"
+ }
+ },
+ "ageRanges": {
+ "description": "The person's read-only age ranges.",
+ "type": "array",
+ "items": {
+ "$ref": "AgeRangeType"
+ }
+ },
+ "addresses": {
+ "description": "The person's street addresses.",
+ "type": "array",
+ "items": {
+ "$ref": "Address"
+ }
+ },
+ "events": {
+ "description": "The person's events.",
+ "type": "array",
+ "items": {
+ "$ref": "Event"
+ }
+ },
+ "memberships": {
+ "description": "The person's read-only group memberships.",
+ "type": "array",
+ "items": {
+ "$ref": "Membership"
+ }
+ },
+ "phoneNumbers": {
+ "description": "The person's phone numbers.",
+ "type": "array",
+ "items": {
+ "$ref": "PhoneNumber"
+ }
+ },
+ "coverPhotos": {
+ "description": "The person's read-only 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 person's read-only relationship interests.",
+ "type": "array",
+ "items": {
+ "$ref": "RelationshipInterest"
+ }
+ },
+ "urls": {
+ "description": "The person's associated URLs.",
+ "type": "array",
+ "items": {
+ "$ref": "Url"
+ }
+ },
+ "nicknames": {
+ "description": "The person's nicknames.",
+ "type": "array",
+ "items": {
+ "$ref": "Nickname"
+ }
+ }
+ }
+ },
+ "UpdateContactGroupRequest": {
+ "id": "UpdateContactGroupRequest",
+ "description": "A request to update an existing contact group. Only the name can be updated.",
+ "type": "object",
+ "properties": {
+ "contactGroup": {
+ "$ref": "ContactGroup",
+ "description": "The contact group to update."
+ }
+ }
+ },
+ "ContactGroupMetadata": {
+ "description": "The read-only metadata about a contact group.",
+ "type": "object",
+ "properties": {
+ "updateTime": {
+ "description": "The time the group was last updated.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "deleted": {
+ "description": "True if the contact group resource has been deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests\nthat include a sync token.",
+ "type": "boolean"
+ }
+ },
+ "id": "ContactGroupMetadata"
+ },
+ "Residence": {
+ "id": "Residence",
+ "description": "A person's past or current residence.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "value": {
+ "description": "The address of the residence.",
+ "type": "string"
+ }
+ }
+ },
+ "Event": {
+ "id": "Event",
+ "description": "An event related to the person.",
+ "type": "object",
+ "properties": {
+ "formattedType": {
+ "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "metadata": {
+ "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."
+ }
+ }
+ },
+ "ModifyContactGroupMembersResponse": {
+ "description": "The response to a modify contact group members request.",
+ "type": "object",
+ "properties": {
+ "notFoundResourceNames": {
+ "description": "The contact people resource names that were not found.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ModifyContactGroupMembersResponse"
+ },
+ "ProfileMetadata": {
+ "id": "ProfileMetadata",
+ "description": "The read-only metadata about a profile.",
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Person.",
+ "[Google+ Page.](http://www.google.com/+/brands/)"
+ ],
+ "enum": [
+ "OBJECT_TYPE_UNSPECIFIED",
+ "PERSON",
+ "PAGE"
+ ],
+ "description": "The profile object type.",
+ "type": "string"
+ },
+ "userTypes": {
+ "enumDescriptions": [
+ "The user type is not known.",
+ "The user is a Google user.",
+ "The user is a Google+ user.",
+ "The user is a Google Apps for Work user."
+ ],
+ "description": "The user types.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "USER_TYPE_UNKNOWN",
+ "GOOGLE_USER",
+ "GPLUS_USER",
+ "GOOGLE_APPS_USER"
+ ]
+ }
+ }
+ }
+ },
+ "Gender": {
+ "id": "Gender",
+ "description": "A person's gender.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
+ "type": "string"
+ },
+ "formattedValue": {
+ "description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the gender."
+ }
+ }
+ },
+ "CoverPhoto": {
+ "description": "A person's read-only cover photo. A large image shown on the person's\nprofile page that represents who they are or what they care about.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "The URL of the cover photo.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the cover photo."
+ },
+ "default": {
+ "description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
+ "type": "boolean"
+ }
+ },
+ "id": "CoverPhoto"
+ },
+ "Interest": {
+ "id": "Interest",
+ "description": "One of the person's interests.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The interest; for example, `stargazing`.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the interest.",
+ "$ref": "FieldMetadata"
+ }
+ }
+ },
+ "EmailAddress": {
+ "id": "EmailAddress",
+ "description": "A person's email address.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The display name of the email.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the email address.",
+ "$ref": "FieldMetadata"
+ },
+ "type": {
+ "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
+ "type": "string"
+ },
+ "value": {
+ "description": "The email address.",
+ "type": "string"
+ },
+ "formattedType": {
+ "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ }
+ }
+ },
+ "Nickname": {
+ "description": "A person's nickname.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the nickname.",
+ "$ref": "FieldMetadata"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Generic nickname.",
+ "Maiden name or birth family name. Used when the person's family name has\nchanged as a result of marriage.",
+ "Initials.",
+ "Google+ profile nickname.",
+ "A professional affiliation or other name; for example, `Dr. Smith.`"
+ ],
+ "enum": [
+ "DEFAULT",
+ "MAIDEN_NAME",
+ "INITIALS",
+ "GPLUS",
+ "OTHER_NAME"
+ ],
+ "description": "The type of the nickname.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The nickname.",
+ "type": "string"
+ }
+ },
+ "id": "Nickname"
+ },
+ "Skill": {
+ "id": "Skill",
+ "description": "A skill that the person has.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The skill; for example, `underwater basket weaving`.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the skill."
+ }
+ }
}
},
"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": "People Service",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/user.phonenumbers.read": {
- "description": "View your phone numbers"
- },
"https://www.googleapis.com/auth/userinfo.email": {
"description": "View your email address"
},
- "https://www.googleapis.com/auth/contacts.readonly": {
- "description": "View your contacts"
+ "https://www.googleapis.com/auth/user.phonenumbers.read": {
+ "description": "View your phone numbers"
},
"https://www.googleapis.com/auth/user.birthday.read": {
"description": "View your complete date of birth"
},
+ "https://www.googleapis.com/auth/contacts.readonly": {
+ "description": "View your contacts"
+ },
"https://www.googleapis.com/auth/plus.login": {
"description": "Know the list of people in your circles, your age range, and language"
},
@@ -1415,315 +1409,27 @@
"title": "Google People API",
"ownerName": "Google",
"resources": {
- "contactGroups": {
- "methods": {
- "get": {
- "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.",
- "response": {
- "$ref": "ContactGroup"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "maxMembers": {
- "location": "query",
- "format": "int32",
- "description": "Specifies the maximum number of members to return.",
- "type": "integer"
- },
- "resourceName": {
- "pattern": "^contactGroups/[^/]+$",
- "location": "path",
- "description": "The resource name of the contact group to get.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "flatPath": "v1/contactGroups/{contactGroupsId}",
- "id": "people.contactGroups.get",
- "path": "v1/{+resourceName}"
- },
- "update": {
- "request": {
- "$ref": "UpdateContactGroupRequest"
- },
- "description": "Update the name of an existing contact group owned by the authenticated\nuser.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "resourceName"
- ],
- "response": {
- "$ref": "ContactGroup"
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "parameters": {
- "resourceName": {
- "pattern": "^contactGroups/[^/]+$",
- "location": "path",
- "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/contactGroups/{contactGroupsId}",
- "path": "v1/{+resourceName}",
- "id": "people.contactGroups.update"
- },
- "batchGet": {
- "response": {
- "$ref": "BatchGetContactGroupsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "resourceNames": {
- "description": "The resource names of the contact groups to get.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "maxMembers": {
- "location": "query",
- "format": "int32",
- "description": "Specifies the maximum number of members to return for each group.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "flatPath": "v1/contactGroups:batchGet",
- "id": "people.contactGroups.batchGet",
- "path": "v1/contactGroups:batchGet",
- "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names."
- },
- "delete": {
- "flatPath": "v1/contactGroups/{contactGroupsId}",
- "path": "v1/{+resourceName}",
- "id": "people.contactGroups.delete",
- "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "parameters": {
- "resourceName": {
- "location": "path",
- "description": "The resource name of the contact group to delete.",
- "type": "string",
- "required": true,
- "pattern": "^contactGroups/[^/]+$"
- },
- "deleteContacts": {
- "location": "query",
- "description": "Set to true to also delete the contacts in the specified group.",
- "type": "boolean"
- }
- }
- },
- "list": {
- "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListContactGroupsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of resources to return.",
- "type": "integer"
- },
- "syncToken": {
- "description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The next_page_token value returned from a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/list).\nRequests the next page of resources.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "flatPath": "v1/contactGroups",
- "path": "v1/contactGroups",
- "id": "people.contactGroups.list"
- },
- "create": {
- "flatPath": "v1/contactGroups",
- "path": "v1/contactGroups",
- "id": "people.contactGroups.create",
- "description": "Create a new contact group owned by the authenticated user.",
- "request": {
- "$ref": "CreateContactGroupRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "ContactGroup"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ]
- }
- },
- "resources": {
- "members": {
- "methods": {
- "modify": {
- "response": {
- "$ref": "ModifyContactGroupMembersResponse"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "parameters": {
- "resourceName": {
- "description": "The resource name of the contact group to modify.",
- "type": "string",
- "required": true,
- "pattern": "^contactGroups/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/contactGroups/{contactGroupsId}/members:modify",
- "id": "people.contactGroups.members.modify",
- "path": "v1/{+resourceName}/members:modify",
- "request": {
- "$ref": "ModifyContactGroupMembersRequest"
- },
- "description": "Modify the members of a contact group owned by the authenticated user."
- }
- }
- }
- }
- },
"people": {
- "resources": {
- "connections": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListConnectionsResponse"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "parameters": {
- "requestSyncToken": {
- "location": "query",
- "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.",
- "type": "boolean"
- },
- "resourceName": {
- "pattern": "^people/[^/]+$",
- "location": "path",
- "description": "The resource name to return connections for. Only `people/me` is valid.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "description": "The token of the page to be returned.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "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"
- },
- "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"
- },
- "syncToken": {
- "location": "query",
- "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned.",
- "type": "string"
- },
- "personFields": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
- "type": "string"
- },
- "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"
- }
- },
- "flatPath": "v1/people/{peopleId}/connections",
- "path": "v1/{+resourceName}/connections",
- "id": "people.people.connections.list",
- "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified."
- }
- }
- }
- },
"methods": {
"getBatchGet": {
- "httpMethod": "GET",
- "response": {
- "$ref": "GetPeopleResponse"
- },
- "parameterOrder": [],
"parameters": {
- "requestMask.includeField": {
+ "personFields": {
"location": "query",
+ "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
"format": "google-fieldmask",
- "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"
},
+ "requestMask.includeField": {
+ "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
"resourceNames": {
"description": "The resource names of the people to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up to 50 resource names in one request.",
"type": "string",
"repeated": true,
"location": "query"
- },
- "personFields": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
- "type": "string"
}
},
"scopes": [
@@ -1740,40 +1446,22 @@
"flatPath": "v1/people:batchGet",
"path": "v1/people:batchGet",
"id": "people.people.getBatchGet",
- "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified."
+ "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
+ "response": {
+ "$ref": "GetPeopleResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET"
},
"get": {
- "path": "v1/{+resourceName}",
- "id": "people.people.get",
"description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
- "httpMethod": "GET",
- "parameterOrder": [
- "resourceName"
- ],
"response": {
"$ref": "Person"
},
- "parameters": {
- "personFields": {
- "format": "google-fieldmask",
- "description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
- "type": "string",
- "location": "query"
- },
- "resourceName": {
- "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).",
- "type": "string",
- "required": true,
- "pattern": "^people/[^/]+$",
- "location": "path"
- },
- "requestMask.includeField": {
- "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",
- "location": "query"
- }
- },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly",
@@ -1785,109 +1473,452 @@
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/userinfo.profile"
],
- "flatPath": "v1/people/{peopleId}"
- },
- "updateContact": {
- "request": {
- "$ref": "Person"
- },
- "description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n\u003cbr\u003e\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n\u003cbr\u003e\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
- "response": {
- "$ref": "Person"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
"parameters": {
"resourceName": {
- "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
- "type": "string",
- "required": true,
"pattern": "^people/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).",
+ "required": true,
+ "type": "string"
},
- "updatePersonFields": {
+ "personFields": {
+ "location": "query",
+ "description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
"format": "google-fieldmask",
- "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "requestMask.includeField": {
+ "location": "query",
+ "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
+ "format": "google-fieldmask",
+ "type": "string"
}
},
- "flatPath": "v1/people/{peopleId}:updateContact",
- "id": "people.people.updateContact",
- "path": "v1/{+resourceName}:updateContact"
+ "flatPath": "v1/people/{peopleId}",
+ "path": "v1/{+resourceName}",
+ "id": "people.people.get"
},
- "createContact": {
- "path": "v1/people:createContact",
- "id": "people.people.createContact",
- "description": "Create a new contact and return the person resource for that contact.",
- "request": {
- "$ref": "Person"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Person"
- },
+ "updateContact": {
"parameters": {
- "parent": {
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "location": "path",
+ "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "required": true,
+ "type": "string"
+ },
+ "updatePersonFields": {
"location": "query",
- "description": "The resource name of the owning person resource.",
+ "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls",
+ "format": "google-fieldmask",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
- "flatPath": "v1/people:createContact"
+ "flatPath": "v1/people/{peopleId}:updateContact",
+ "id": "people.people.updateContact",
+ "path": "v1/{+resourceName}:updateContact",
+ "request": {
+ "$ref": "Person"
+ },
+ "description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n\u003cbr\u003e\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n\u003cbr\u003e\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "response": {
+ "$ref": "Person"
+ }
+ },
+ "createContact": {
+ "description": "Create a new contact and return the person resource for that contact.",
+ "request": {
+ "$ref": "Person"
+ },
+ "response": {
+ "$ref": "Person"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the owning person resource.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/people:createContact",
+ "path": "v1/people:createContact",
+ "id": "people.people.createContact"
},
"deleteContact": {
+ "id": "people.people.deleteContact",
+ "path": "v1/{+resourceName}:deleteContact",
+ "description": "Delete a contact person. Any non-contact data will not be deleted.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "parameters": {
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the contact to delete.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/people/{peopleId}:deleteContact"
+ }
+ },
+ "resources": {
+ "connections": {
+ "methods": {
+ "list": {
+ "path": "v1/{+resourceName}/connections",
+ "id": "people.people.connections.list",
+ "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
+ "response": {
+ "$ref": "ListConnectionsResponse"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "parameters": {
+ "syncToken": {
+ "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "personFields": {
+ "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "sortOrder": {
+ "location": "query",
+ "enum": [
+ "LAST_MODIFIED_ASCENDING",
+ "FIRST_NAME_ASCENDING",
+ "LAST_NAME_ASCENDING"
+ ],
+ "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
+ "type": "string"
+ },
+ "requestSyncToken": {
+ "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"
+ },
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "location": "path",
+ "description": "The resource name to return connections for. Only `people/me` is valid.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The token of the page to be returned.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "requestMask.includeField": {
+ "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/people/{peopleId}/connections"
+ }
+ }
+ }
+ }
+ },
+ "contactGroups": {
+ "methods": {
+ "batchGet": {
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "parameters": {
+ "maxMembers": {
+ "description": "Specifies the maximum number of members to return for each group.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "resourceNames": {
+ "description": "The resource names of the contact groups to get.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/contactGroups:batchGet",
+ "path": "v1/contactGroups:batchGet",
+ "id": "people.contactGroups.batchGet",
+ "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names.",
+ "response": {
+ "$ref": "BatchGetContactGroupsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET"
+ },
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "parameters": {
+ "resourceName": {
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the contact group to delete.",
+ "required": true,
+ "type": "string"
+ },
+ "deleteContacts": {
+ "description": "Set to true to also delete the contacts in the specified group.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/contactGroups/{contactGroupsId}",
+ "path": "v1/{+resourceName}",
+ "id": "people.contactGroups.delete",
+ "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"resourceName"
],
- "httpMethod": "DELETE",
+ "httpMethod": "DELETE"
+ },
+ "list": {
+ "path": "v1/contactGroups",
+ "id": "people.contactGroups.list",
+ "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.",
+ "response": {
+ "$ref": "ListContactGroupsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "syncToken": {
+ "description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The next_page_token value returned from a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/list).\nRequests the next page of resources.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of resources to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "flatPath": "v1/contactGroups"
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateContactGroupRequest"
+ },
+ "description": "Create a new contact group owned by the authenticated user.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ContactGroup"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/contactGroups",
+ "id": "people.contactGroups.create",
+ "path": "v1/contactGroups"
+ },
+ "get": {
+ "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "response": {
+ "$ref": "ContactGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "parameters": {
+ "maxMembers": {
+ "location": "query",
+ "description": "Specifies the maximum number of members to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "resourceName": {
+ "description": "The resource name of the contact group to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/contactGroups/{contactGroupsId}",
+ "id": "people.contactGroups.get",
+ "path": "v1/{+resourceName}"
+ },
+ "update": {
+ "id": "people.contactGroups.update",
+ "path": "v1/{+resourceName}",
+ "request": {
+ "$ref": "UpdateContactGroupRequest"
+ },
+ "description": "Update the name of an existing contact group owned by the authenticated\nuser.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "response": {
+ "$ref": "ContactGroup"
+ },
"parameters": {
"resourceName": {
- "description": "The resource name of the contact to delete.",
- "type": "string",
+ "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
"required": true,
- "pattern": "^people/[^/]+$",
+ "type": "string",
+ "pattern": "^contactGroups/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
- "flatPath": "v1/people/{peopleId}:deleteContact",
- "id": "people.people.deleteContact",
- "path": "v1/{+resourceName}:deleteContact",
- "description": "Delete a contact person. Any non-contact data will not be deleted."
+ "flatPath": "v1/contactGroups/{contactGroupsId}"
+ }
+ },
+ "resources": {
+ "members": {
+ "methods": {
+ "modify": {
+ "request": {
+ "$ref": "ModifyContactGroupMembersRequest"
+ },
+ "description": "Modify the members of a contact group owned by the authenticated user.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "response": {
+ "$ref": "ModifyContactGroupMembersResponse"
+ },
+ "parameters": {
+ "resourceName": {
+ "description": "The resource name of the contact group to modify.",
+ "required": true,
+ "type": "string",
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/contactGroups/{contactGroupsId}/members:modify",
+ "id": "people.contactGroups.members.modify",
+ "path": "v1/{+resourceName}/members:modify"
+ }
+ }
}
}
}
},
"parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial 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"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -1902,8 +1933,12 @@
"description": "V1 error format.",
"type": "string"
},
- "alt": {
+ "callback": {
+ "description": "JSONP",
"type": "string",
+ "location": "query"
+ },
+ "alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1916,49 +1951,14 @@
"json",
"media",
"proto"
- ]
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ ],
"type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
}
- }
+ },
+ "version": "v1",
+ "baseUrl": "https://people.googleapis.com/",
+ "servicePath": "",
+ "description": "Provides access to information about profiles and contacts.",
+ "kind": "discovery#restDescription",
+ "basePath": ""
}
diff --git a/people/v1/people-gen.go b/people/v1/people-gen.go
index dfccdf3..47ff5bd 100644
--- a/people/v1/people-gen.go
+++ b/people/v1/people-gen.go
@@ -1608,8 +1608,7 @@
// Relations: The person's relations.
Relations []*Relation `json:"relations,omitempty"`
- // RelationshipInterests: The person's read-only relationship
- // interests.g4
+ // RelationshipInterests: The person's read-only relationship interests.
RelationshipInterests []*RelationshipInterest `json:"relationshipInterests,omitempty"`
// RelationshipStatuses: The person's read-only relationship statuses.
diff --git a/playmoviespartner/v1/playmoviespartner-api.json b/playmoviespartner/v1/playmoviespartner-api.json
index 4bc8212..5e2a9c5 100644
--- a/playmoviespartner/v1/playmoviespartner-api.json
+++ b/playmoviespartner/v1/playmoviespartner-api.json
@@ -1,22 +1,54 @@
{
- "rootUrl": "https://playmoviespartner.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "playmoviespartner",
- "batchPath": "batch",
- "revision": "20170815",
- "documentationLink": "https://developers.google.com/playmoviespartner/",
- "id": "playmoviespartner:v1",
- "title": "Google Play Movies Partner API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
"resources": {
"accounts": {
"resources": {
"storeInfos": {
+ "resources": {
+ "country": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "StoreInfo"
+ },
+ "parameterOrder": [
+ "accountId",
+ "videoId",
+ "country"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "country": {
+ "description": "REQUIRED. Edit country.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "videoId": {
+ "location": "path",
+ "description": "REQUIRED. Video ID.",
+ "type": "string",
+ "required": true
+ },
+ "accountId": {
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
+ "flatPath": "v1/accounts/{accountId}/storeInfos/{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."
+ }
+ }
+ }
+ },
"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.",
"response": {
"$ref": "ListStoreInfosResponse"
},
@@ -29,22 +61,22 @@
],
"parameters": {
"mids": {
+ "repeated": true,
"location": "query",
"description": "Filter StoreInfos that match any of the given `mid`s.",
- "type": "string",
- "repeated": true
+ "type": "string"
},
"pphNames": {
+ "description": "See _List methods rules_ for info about this field.",
"type": "string",
"repeated": true,
- "location": "query",
- "description": "See _List methods rules_ for info about this field."
+ "location": "query"
},
"countries": {
- "type": "string",
"repeated": true,
"location": "query",
- "description": "Filter StoreInfos that match (case-insensitive) any of the given country\ncodes, using the \"ISO 3166-1 alpha-2\" format (examples: \"US\", \"us\", \"Us\")."
+ "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"
},
"name": {
"location": "query",
@@ -52,126 +84,81 @@
"type": "string"
},
"studioNames": {
+ "repeated": true,
"location": "query",
"description": "See _List methods rules_ for info about this field.",
- "type": "string",
- "repeated": true
+ "type": "string"
},
"accountId": {
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
"type": "string",
"required": true,
- "location": "path",
- "description": "REQUIRED. See _General rules_ for more information about this field."
+ "location": "path"
},
"seasonIds": {
+ "description": "Filter StoreInfos that match any of the given `season_id`s.",
"type": "string",
"repeated": true,
- "location": "query",
- "description": "Filter StoreInfos that match any of the given `season_id`s."
+ "location": "query"
},
"videoIds": {
- "type": "string",
"repeated": true,
"location": "query",
- "description": "Filter StoreInfos that match any of the given `video_id`s."
+ "description": "Filter StoreInfos that match any of the given `video_id`s.",
+ "type": "string"
},
"videoId": {
- "type": "string",
"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."
+ "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."
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
},
"pageSize": {
- "type": "integer",
- "location": "query",
"format": "int32",
- "description": "See _List methods rules_ for info about this field."
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "integer",
+ "location": "query"
}
},
"flatPath": "v1/accounts/{accountId}/storeInfos",
"id": "playmoviespartner.accounts.storeInfos.list",
- "path": "v1/accounts/{accountId}/storeInfos"
- }
- },
- "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"
- ],
- "parameters": {
- "country": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "REQUIRED. Edit country."
- },
- "videoId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "REQUIRED. Video ID."
- },
- "accountId": {
- "location": "path",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "type": "string",
- "required": true
- }
- },
- "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",
+ "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."
}
}
},
"orders": {
"methods": {
"list": {
+ "description": "List Orders owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListOrdersResponse"
},
"parameterOrder": [
"accountId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ],
"parameters": {
- "videoIds": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "description": "Filter Orders that match any of the given `video_id`s."
- },
- "customId": {
- "location": "query",
- "description": "Filter Orders that match a case-insensitive, partner-specific custom id.",
- "type": "string"
- },
"pageToken": {
"location": "query",
"description": "See _List methods rules_ for info about this field.",
"type": "string"
},
+ "videoIds": {
+ "description": "Filter Orders that match any of the given `video_id`s.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "customId": {
+ "description": "Filter Orders that match a case-insensitive, partner-specific custom id.",
+ "type": "string",
+ "location": "query"
+ },
"pageSize": {
"location": "query",
"format": "int32",
@@ -179,15 +166,12 @@
"type": "integer"
},
"pphNames": {
+ "description": "See _List methods rules_ for info about this field.",
"type": "string",
"repeated": true,
- "location": "query",
- "description": "See _List methods rules_ for info about this field."
+ "location": "query"
},
"status": {
- "type": "string",
- "repeated": true,
- "location": "query",
"enum": [
"STATUS_UNSPECIFIED",
"STATUS_APPROVED",
@@ -196,32 +180,39 @@
"STATUS_UNFULFILLED",
"STATUS_NOT_AVAILABLE"
],
- "description": "Filter Orders that match one of the given status."
- },
- "name": {
+ "description": "Filter Orders that match one of the given status.",
"type": "string",
- "location": "query",
- "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode`\nthat contains the given case-insensitive name."
+ "repeated": true,
+ "location": "query"
},
"studioNames": {
- "location": "query",
"description": "See _List methods rules_ for info about this field.",
"type": "string",
- "repeated": true
+ "repeated": true,
+ "location": "query"
+ },
+ "name": {
+ "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode`\nthat contains the given case-insensitive name.",
+ "type": "string",
+ "location": "query"
},
"accountId": {
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
"type": "string",
"required": true,
- "location": "path",
- "description": "REQUIRED. See _General rules_ for more information about this field."
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
"flatPath": "v1/accounts/{accountId}/orders",
- "id": "playmoviespartner.accounts.orders.list",
"path": "v1/accounts/{accountId}/orders",
- "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."
+ "id": "playmoviespartner.accounts.orders.list"
},
"get": {
+ "description": "Get an Order given its id.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method.",
+ "httpMethod": "GET",
"response": {
"$ref": "Order"
},
@@ -229,7 +220,6 @@
"accountId",
"orderId"
],
- "httpMethod": "GET",
"parameters": {
"orderId": {
"location": "path",
@@ -238,29 +228,24 @@
"required": true
},
"accountId": {
- "location": "path",
"description": "REQUIRED. See _General rules_ for more information about this field.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/playmovies_partner.readonly"
],
"flatPath": "v1/accounts/{accountId}/orders/{orderId}",
- "id": "playmoviespartner.accounts.orders.get",
"path": "v1/accounts/{accountId}/orders/{orderId}",
- "description": "Get an Order given its id.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method."
+ "id": "playmoviespartner.accounts.orders.get"
}
}
},
"avails": {
"methods": {
"list": {
- "flatPath": "v1/accounts/{accountId}/avails",
- "id": "playmoviespartner.accounts.avails.list",
- "path": "v1/accounts/{accountId}/avails",
- "description": "List Avails owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method.",
"response": {
"$ref": "ListAvailsResponse"
},
@@ -268,71 +253,74 @@
"accountId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ],
"parameters": {
- "altId": {
- "location": "query",
- "description": "Filter Avails that match a case-insensitive, partner-specific custom id.\nNOTE: this field is deprecated and will be removed on V2; `alt_ids`\nshould be used instead.",
- "type": "string"
- },
- "studioNames": {
- "location": "query",
+ "pphNames": {
"description": "See _List methods rules_ for info about this field.",
"type": "string",
- "repeated": true
+ "repeated": true,
+ "location": "query"
},
- "accountId": {
+ "altId": {
+ "description": "Filter Avails that match a case-insensitive, partner-specific custom id.\nNOTE: this field is deprecated and will be removed on V2; `alt_ids`\nshould be used instead.",
"type": "string",
- "required": true,
- "location": "path",
- "description": "REQUIRED. See _General rules_ for more information about this field."
+ "location": "query"
},
- "territories": {
+ "studioNames": {
+ "description": "See _List methods rules_ for info about this field.",
"type": "string",
"repeated": true,
- "location": "query",
- "description": "Filter Avails that match (case-insensitive) any of the given country codes,\nusing the \"ISO 3166-1 alpha-2\" format (examples: \"US\", \"us\", \"Us\")."
+ "location": "query"
+ },
+ "accountId": {
+ "location": "path",
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "type": "string",
+ "required": true
+ },
+ "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\").",
+ "type": "string",
+ "repeated": true,
+ "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"
},
+ "pageToken": {
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
+ },
"videoIds": {
+ "description": "Filter Avails that match any of the given `video_id`s.",
"type": "string",
"repeated": true,
- "location": "query",
- "description": "Filter Avails that match any of the given `video_id`s."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "See _List methods rules_ for info about this field."
+ "location": "query"
},
"pageSize": {
- "type": "integer",
- "location": "query",
"format": "int32",
- "description": "See _List methods rules_ for info about this field."
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "integer",
+ "location": "query"
},
"altIds": {
- "location": "query",
- "description": "Filter Avails that match (case-insensitive) any of the given partner-specific custom ids.",
- "type": "string",
- "repeated": true
- },
- "pphNames": {
- "type": "string",
"repeated": true,
"location": "query",
- "description": "See _List methods rules_ for info about this field."
+ "description": "Filter Avails that match (case-insensitive) any of the given partner-specific custom ids.",
+ "type": "string"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
+ "flatPath": "v1/accounts/{accountId}/avails",
+ "id": "playmoviespartner.accounts.avails.list",
+ "path": "v1/accounts/{accountId}/avails",
+ "description": "List Avails owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method."
},
"get": {
- "description": "Get an Avail given its avail group id and avail id.",
"response": {
"$ref": "Avail"
},
@@ -341,26 +329,27 @@
"availId"
],
"httpMethod": "GET",
+ "parameters": {
+ "availId": {
+ "description": "REQUIRED. Avail ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "accountId": {
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/playmovies_partner.readonly"
],
- "parameters": {
- "availId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "REQUIRED. Avail ID."
- },
- "accountId": {
- "location": "path",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "type": "string",
- "required": true
- }
- },
"flatPath": "v1/accounts/{accountId}/avails/{availId}",
"id": "playmoviespartner.accounts.avails.get",
- "path": "v1/accounts/{accountId}/avails/{availId}"
+ "path": "v1/accounts/{accountId}/avails/{availId}",
+ "description": "Get an Avail given its avail group id and avail id."
}
}
}
@@ -368,34 +357,17 @@
}
},
"parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
"type": "string",
- "location": "query",
- "description": "JSONP"
+ "location": "query"
},
"$.xgafv": {
- "location": "query",
"enum": [
"1",
"2"
@@ -405,9 +377,16 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ]
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
+ "description": "Data format for response.",
"default": "json",
"enum": [
"json",
@@ -420,18 +399,17 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response."
- },
- "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."
+ "location": "query"
},
"access_token": {
+ "description": "OAuth access token.",
"type": "string",
+ "location": "query"
+ },
+ "key": {
"location": "query",
- "description": "OAuth access token."
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
},
"quotaUser": {
"location": "query",
@@ -439,166 +417,74 @@
"type": "string"
},
"pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "type": "boolean"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
}
},
"schemas": {
- "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.",
+ "Order": {
+ "description": "An Order tracks the fulfillment of an Edit when delivered using the\nlegacy, non-component-based delivery.\n\nEach Order is uniquely identified by an `order_id`, which is generated\nby Google.\n\nExternally, Orders can also be identified by partners using its `custom_id`\n(when provided).",
"type": "object",
"properties": {
- "country": {
- "description": "Country where Edit is available in ISO 3166-1 alpha-2 country\ncode.\nExample: \"US\".",
+ "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"
},
- "showId": {
- "type": "string",
- "description": "Google-generated ID identifying the show linked to the Edit.\nOnly available for TV Edits.\nExample: 'et2hsue_x'"
- },
- "type": {
- "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"
- ],
- "description": "Edit type, like Movie, Episode or Season."
- },
- "trailerId": {
- "type": "string",
- "description": "Google-generated ID identifying the trailer linked to the Edit.\nExample: 'bhd_4e_cx'"
- },
- "hasHdOffer": {
- "type": "boolean",
- "description": "Whether the Edit has a HD offer."
- },
- "mid": {
- "description": "Knowledge Graph ID associated to this Edit, if available.\nThis ID links the Edit to its knowledge entity, externally accessible\nat http://freebase.com.\nIn the absense of Title EIDR or Edit EIDR, this ID helps link together\nmultiple Edits across countries.\nExample: '/m/0ffx29'",
+ "channelName": {
+ "description": "YouTube Channel Name that should be used to fulfill the Order.\nExample: \"Google_channel\".",
"type": "string"
},
- "hasAudio51": {
- "description": "Whether the Edit has a 5.1 channel audio track.",
- "type": "boolean"
- },
- "name": {
- "type": "string",
- "description": "Default Edit name, usually in the language of the country of\norigin.\nExample: \"Googlers, The\"."
- },
- "seasonId": {
- "description": "Google-generated ID identifying the season linked to the Edit.\nOnly available for TV Edits.\nExample: 'ster23ex'",
- "type": "string"
- },
- "titleLevelEidr": {
- "description": "Title-level EIDR ID.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-5\".",
- "type": "string"
- },
- "seasonName": {
- "type": "string",
- "description": "Default Season name, usually in the language of the country of\norigin.\nOnly available for TV Edits\nExample: \"Googlers, The - A Brave New World\"."
- },
- "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": {
- "type": "string",
- "description": "Edit-level EIDR ID.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-6\"."
- },
- "hasSdOffer": {
- "type": "boolean",
- "description": "Whether the Edit has a SD offer."
- },
- "liveTime": {
+ "approvedTime": {
"format": "google-datetime",
- "description": "Timestamp when the Edit went live on the Store.",
+ "description": "Timestamp when the Order was approved.",
"type": "string"
},
- "videoId": {
- "type": "string",
- "description": "Google-generated ID identifying the video linked to the Edit.\nExample: 'gtry456_xc'"
- },
- "hasInfoCards": {
- "type": "boolean",
- "description": "Whether the Edit has info cards."
- },
- "hasVodOffer": {
- "description": "Whether the Edit has a VOD offer.",
- "type": "boolean"
- },
- "pphNames": {
- "description": "Name of the post-production houses that manage the Edit.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "episodeNumber": {
- "description": "The number assigned to the episode within a season.\nOnly available on TV Edits.\nExample: \"1\".",
- "type": "string"
- },
- "studioName": {
- "description": "Name of the studio that owns the Edit ordered.",
- "type": "string"
- },
- "subtitles": {
- "description": "Subtitles available for this Edit.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "audioTracks": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Audio tracks available for this Edit."
- },
"showName": {
- "type": "string",
- "description": "Default Show name, usually in the language of the country of\norigin.\nOnly available for TV Edits\nExample: \"Googlers, The\"."
- }
- },
- "id": "StoreInfo"
- },
- "Avail": {
- "type": "object",
- "properties": {
- "workType": {
+ "description": "Default Show name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
+ "orderId": {
+ "description": "ID internally generated by Google to uniquely identify an Order.\nExample: 'abcde12_x'",
+ "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 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\""
- ],
+ "A low-priority asset, typically from a library movie.",
+ "A high-priority asset, typically from a new release or box office hit."
+ ]
+ },
+ "type": {
"enum": [
"TITLE_TYPE_UNSPECIFIED",
"MOVIE",
@@ -606,195 +492,57 @@
"EPISODE",
"BUNDLE"
],
- "description": "Work type as enumerated in EMA."
- },
- "availId": {
- "type": "string",
- "description": "ID internally generated by Google to uniquely identify an Avail.\nNot part of EMA Specs."
- },
- "ratingReason": {
- "description": "Value representing the rating reason.\nRating reasons should be formatted as per\n[EMA ratings spec](http://www.movielabs.com/md/ratings/)\nand comma-separated for inclusion of multiple reasons.\nExample: \"L, S, V\"",
- "type": "string"
- },
- "episodeTitleInternalAlias": {
- "type": "string",
- "description": "OPTIONAL.TV Only. Title used by involved parties to refer to this episode.\nOnly available on TV Avails.\nExample: \"Coding at Google\"."
- },
- "suppressionLiftDate": {
- "type": "string",
- "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\""
- },
- "seasonAltId": {
- "type": "string",
- "description": "Other identifier referring to the season, as defined by partner.\nOnly available on TV avails.\nExample: \"rs_googlers_s1\"."
- },
- "encodeId": {
- "type": "string",
- "description": "Manifestation Identifier. This should be the Manifestation\nLevel EIDR.\nExample: \"10.2340/1489-49A2-3956-4B2D-FE16-7\""
- },
- "priceType": {
- "type": "string",
- "description": "Type of pricing that should be applied to this Avail\nbased on how the partner classify them.\nExample: \"Tier\", \"WSP\", \"SRP\", or \"Category\"."
- },
- "captionIncluded": {
- "description": "Communicating if caption file will be delivered.",
- "type": "boolean"
- },
- "licenseType": {
+ "description": "Type of the Edit linked to the Order.",
"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"
- ],
- "description": "Type of transaction."
+ "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\""
+ ]
},
- "seasonNumber": {
- "description": "The number assigned to the season within a series.\nOnly available on TV Avails.\nExample: \"1\".",
+ "rejectionNote": {
+ "description": "Field explaining why an Order has been rejected.\nExample: \"Trailer audio is 2ch mono, please re-deliver in stereo\".",
"type": "string"
},
- "releaseDate": {
- "description": "Release date of the Title in earliest released territory.\nTypically it is just the year, but it is free-form as per EMA spec.\nExamples: \"1979\", \"Oct 2014\"",
+ "channelId": {
+ "description": "YouTube Channel ID that should be used to fulfill the Order.\nExample: \"UCRG64darCZhb\".",
"type": "string"
},
- "end": {
- "type": "string",
- "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\""
+ "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"
+ },
+ "priority": {
+ "format": "double",
+ "description": "Order priority, as defined by Google.\nThe higher the value, the higher the priority.\nExample: 90",
+ "type": "number"
+ },
+ "orderedTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when the Order was created.",
+ "type": "string"
},
"videoId": {
- "description": "Google-generated ID identifying the video linked to this Avail, once\ndelivered.\nNot part of EMA Specs.\nExample: 'gtry456_xc'",
+ "description": "Google-generated ID identifying the video linked to this Order, once\ndelivered.\nExample: 'gtry456_xc'.",
"type": "string"
},
- "start": {
- "type": "string",
- "description": "Start of term in YYYY-MM-DD format in the timezone of the\ncountry of the Avail.\nExample: \"2013-05-14\"."
+ "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"
},
- "ratingSystem": {
- "type": "string",
- "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\""
- },
- "pphNames": {
+ "countries": {
+ "description": "Countries where the Order is available,\nusing the \"ISO 3166-1 alpha-2\" format (example: \"US\").",
"items": {
"type": "string"
},
- "type": "array",
- "description": "Name of the post-production houses that manage the Avail.\nNot part of EMA Specs."
+ "type": "array"
},
- "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": {
- "type": "string",
- "description": "The number assigned to the episode within a season.\nOnly available on TV Avails.\nExample: \"3\"."
- },
- "seriesTitleInternalAlias": {
- "description": "Title used by involved parties to refer to this series.\nOnly available on TV Avails.\nExample: \"Googlers, The\".",
- "type": "string"
- },
- "formatProfile": {
- "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"
- ],
- "description": "Indicates the format profile covered by the transaction."
- },
- "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": {
- "type": "string",
- "description": "Value representing the rating.\nRatings should be formatted as per http://www.movielabs.com/md/ratings/\nExample: \"PG\""
- },
- "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": {
- "type": "string",
- "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\"."
- },
- "captionExemption": {
- "type": "string",
- "description": "Communicating an exempt category as defined by FCC regulations.\nIt is not required for non-US Avails.\nExample: \"1\""
- },
- "seasonTitleInternalAlias": {
- "description": "Title used by involved parties to refer to this season.\nOnly available on TV Avails.\nExample: \"Googlers, The\".",
- "type": "string"
- },
- "priceValue": {
- "type": "string",
- "description": "Value to be applied to the pricing type.\nExample: \"4\" or \"2.99\""
- },
- "episodeAltId": {
- "description": "Other identifier referring to the episode, as defined by partner.\nOnly available on TV avails.\nExample: \"rs_googlers_s1_3\".",
- "type": "string"
- },
- "territory": {
- "type": "string",
- "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\"."
- }
- },
- "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": {
- "nextPageToken": {
- "description": "See _List methods rules_ for info about this field.",
- "type": "string"
- },
- "totalSize": {
- "format": "int32",
- "description": "See _List methods rules_ for more information about this field.",
- "type": "integer"
- },
- "orders": {
- "items": {
- "$ref": "Order"
- },
- "type": "array",
- "description": "List of Orders that match the request criteria."
- }
- },
- "id": "ListOrdersResponse",
- "description": "Response to the 'ListOrders' method."
- },
- "Order": {
- "type": "object",
- "properties": {
"statusDetail": {
"enum": [
"ORDER_STATUS_UNSPECIFIED",
@@ -855,119 +603,22 @@
"type": "string"
},
"receivedTime": {
- "type": "string",
"format": "google-datetime",
- "description": "Timestamp when the Order was fulfilled."
+ "description": "Timestamp when the Order was fulfilled.",
+ "type": "string"
},
"seasonName": {
"description": "Default Season name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The - A Brave New World\".",
"type": "string"
- },
- "customId": {
- "type": "string",
- "description": "ID that can be used to externally identify an Order.\nThis ID is provided by partners when submitting the Avails.\nExample: 'GOOGLER_2006'"
- },
- "channelName": {
- "description": "YouTube Channel Name that should be used to fulfill the Order.\nExample: \"Google_channel\".",
- "type": "string"
- },
- "approvedTime": {
- "format": "google-datetime",
- "description": "Timestamp when the Order was approved.",
- "type": "string"
- },
- "showName": {
- "description": "Default Show name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The\".",
- "type": "string"
- },
- "normalizedPriority": {
- "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"
- ],
- "description": "A simpler representation of the priority."
- },
- "orderId": {
- "description": "ID internally generated by Google to uniquely identify an Order.\nExample: 'abcde12_x'",
- "type": "string"
- },
- "type": {
- "enum": [
- "TITLE_TYPE_UNSPECIFIED",
- "MOVIE",
- "SEASON",
- "EPISODE",
- "BUNDLE"
- ],
- "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.",
- "A season of a TV show.",
- "An episode of a TV show.",
- "A collection of movies, i.e. \"Googlers 1 and Googlers, the return\""
- ]
- },
- "rejectionNote": {
- "type": "string",
- "description": "Field explaining why an Order has been rejected.\nExample: \"Trailer audio is 2ch mono, please re-deliver in stereo\"."
- },
- "channelId": {
- "type": "string",
- "description": "YouTube Channel ID that should be used to fulfill the Order.\nExample: \"UCRG64darCZhb\"."
- },
- "pphName": {
- "type": "string",
- "description": "Name of the post-production house that manages the Edit ordered."
- },
- "legacyPriority": {
- "type": "string",
- "description": "Legacy Order priority, as defined by Google.\nExample: 'P0'"
- },
- "priority": {
- "format": "double",
- "description": "Order priority, as defined by Google.\nThe higher the value, the higher the priority.\nExample: 90",
- "type": "number"
- },
- "orderedTime": {
- "format": "google-datetime",
- "description": "Timestamp when the Order was created.",
- "type": "string"
- },
- "videoId": {
- "type": "string",
- "description": "Google-generated ID identifying the video linked to this Order, once\ndelivered.\nExample: 'gtry456_xc'."
- },
- "episodeName": {
- "description": "Default Episode name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The - Pilot\".",
- "type": "string"
- },
- "countries": {
- "description": "Countries where the Order is available,\nusing the \"ISO 3166-1 alpha-2\" format (example: \"US\").",
- "items": {
- "type": "string"
- },
- "type": "array"
}
},
- "id": "Order",
- "description": "An Order tracks the fulfillment of an Edit when delivered using the\nlegacy, non-component-based delivery.\n\nEach Order is uniquely identified by an `order_id`, which is generated\nby Google.\n\nExternally, Orders can also be identified by partners using its `custom_id`\n(when provided)."
+ "id": "Order"
},
"ListStoreInfosResponse": {
- "description": "Response to the 'ListStoreInfos' method.",
- "type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "See 'List methods rules' for info about this field."
+ "description": "See 'List methods rules' for info about this field.",
+ "type": "string"
},
"totalSize": {
"format": "int32",
@@ -982,21 +633,47 @@
"type": "array"
}
},
- "id": "ListStoreInfosResponse"
+ "id": "ListStoreInfosResponse",
+ "description": "Response to the 'ListStoreInfos' method.",
+ "type": "object"
},
"ListAvailsResponse": {
- "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
+ },
+ "totalSize": {
+ "format": "int32",
+ "description": "See _List methods rules_ for more information about this field.",
+ "type": "integer"
+ },
"avails": {
+ "description": "List of Avails that match the request criteria.",
"items": {
"$ref": "Avail"
},
- "type": "array",
- "description": "List of Avails that match the request criteria."
+ "type": "array"
+ }
+ },
+ "id": "ListAvailsResponse",
+ "description": "Response to the 'ListAvails' method.",
+ "type": "object"
+ },
+ "ListOrdersResponse": {
+ "description": "Response to the 'ListOrders' method.",
+ "type": "object",
+ "properties": {
+ "orders": {
+ "description": "List of Orders that match the request criteria.",
+ "items": {
+ "$ref": "Order"
+ },
+ "type": "array"
},
"nextPageToken": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field."
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
},
"totalSize": {
"format": "int32",
@@ -1004,8 +681,320 @@
"type": "integer"
}
},
- "id": "ListAvailsResponse",
- "description": "Response to the 'ListAvails' method."
+ "id": "ListOrdersResponse"
+ },
+ "StoreInfo": {
+ "properties": {
+ "titleLevelEidr": {
+ "description": "Title-level EIDR ID.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-5\".",
+ "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"
+ },
+ "seasonNumber": {
+ "description": "The number assigned to the season within a show.\nOnly available on TV Edits.\nExample: \"1\".",
+ "type": "string"
+ },
+ "editLevelEidr": {
+ "description": "Edit-level EIDR ID.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-6\".",
+ "type": "string"
+ },
+ "hasEstOffer": {
+ "description": "Whether the Edit has a EST offer.",
+ "type": "boolean"
+ },
+ "hasSdOffer": {
+ "description": "Whether the Edit has a SD offer.",
+ "type": "boolean"
+ },
+ "videoId": {
+ "description": "Google-generated ID identifying the video linked to the Edit.\nExample: 'gtry456_xc'",
+ "type": "string"
+ },
+ "liveTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when the Edit went live on the Store.",
+ "type": "string"
+ },
+ "hasInfoCards": {
+ "description": "Whether the Edit has info cards.",
+ "type": "boolean"
+ },
+ "hasVodOffer": {
+ "description": "Whether the Edit has a VOD offer.",
+ "type": "boolean"
+ },
+ "pphNames": {
+ "description": "Name of the post-production houses that manage the Edit.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "episodeNumber": {
+ "description": "The number assigned to the episode within a season.\nOnly available on TV Edits.\nExample: \"1\".",
+ "type": "string"
+ },
+ "studioName": {
+ "description": "Name of the studio that owns the Edit ordered.",
+ "type": "string"
+ },
+ "subtitles": {
+ "description": "Subtitles available for this Edit.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "audioTracks": {
+ "description": "Audio tracks available for this Edit.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "showName": {
+ "description": "Default Show name, usually in the language of the country of\norigin.\nOnly available for TV Edits\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
+ "country": {
+ "description": "Country where Edit is available in ISO 3166-1 alpha-2 country\ncode.\nExample: \"US\".",
+ "type": "string"
+ },
+ "showId": {
+ "description": "Google-generated ID identifying the show linked to the Edit.\nOnly available for TV Edits.\nExample: 'et2hsue_x'",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Value could not be determined, please contact technical support if\nit should.",
+ "A movie picture.",
+ "A season of a TV show.",
+ "An episode of a TV show.",
+ "A collection of movies, i.e. \"Googlers 1 and Googlers, the return\""
+ ],
+ "enum": [
+ "TITLE_TYPE_UNSPECIFIED",
+ "MOVIE",
+ "SEASON",
+ "EPISODE",
+ "BUNDLE"
+ ],
+ "description": "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'",
+ "type": "string"
+ },
+ "hasHdOffer": {
+ "description": "Whether the Edit has a HD offer.",
+ "type": "boolean"
+ },
+ "mid": {
+ "description": "Knowledge Graph ID associated to this Edit, if available.\nThis ID links the Edit to its knowledge entity, externally accessible\nat http://freebase.com.\nIn the absense of Title EIDR or Edit EIDR, this ID helps link together\nmultiple Edits across countries.\nExample: '/m/0ffx29'",
+ "type": "string"
+ },
+ "hasAudio51": {
+ "description": "Whether the Edit has a 5.1 channel audio track.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Default Edit name, usually in the language of the country of\norigin.\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
+ "seasonId": {
+ "description": "Google-generated ID identifying the season linked to the Edit.\nOnly available for TV Edits.\nExample: 'ster23ex'",
+ "type": "string"
+ }
+ },
+ "id": "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"
+ },
+ "Avail": {
+ "properties": {
+ "altId": {
+ "description": "Other identifier referring to the Edit, as defined by partner.\nExample: \"GOOGLER_2006\"",
+ "type": "string"
+ },
+ "episodeNumber": {
+ "description": "The number assigned to the episode within a season.\nOnly available on TV Avails.\nExample: \"3\".",
+ "type": "string"
+ },
+ "seriesTitleInternalAlias": {
+ "description": "Title used by involved parties to refer to this series.\nOnly available on TV Avails.\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
+ "formatProfile": {
+ "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"
+ },
+ "ratingValue": {
+ "description": "Value representing the rating.\nRatings should be formatted as per http://www.movielabs.com/md/ratings/\nExample: \"PG\"",
+ "type": "string"
+ },
+ "titleInternalAlias": {
+ "description": "Title used by involved parties to refer to this content.\nExample: \"Googlers, The\".\nOnly available on Movie Avails.",
+ "type": "string"
+ },
+ "contentId": {
+ "description": "Title Identifier. This should be the Title Level EIDR.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-5\".",
+ "type": "string"
+ },
+ "storeLanguage": {
+ "description": "Spoken language of the intended audience.\nLanguage shall be encoded in accordance with RFC 5646.\nExample: \"fr\".",
+ "type": "string"
+ },
+ "captionExemption": {
+ "description": "Communicating an exempt category as defined by FCC regulations.\nIt is not required for non-US Avails.\nExample: \"1\"",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The name of the studio that owns the Edit referred in the Avail.\nThis is the equivalent of `studio_name` in other resources, but it follows\nthe EMA nomenclature.\nExample: \"Google Films\".",
+ "type": "string"
+ },
+ "productId": {
+ "description": "Edit Identifier. This should be the Edit Level EIDR.\nExample: \"10.2340/1489-49A2-3956-4B2D-FE16-6\"",
+ "type": "string"
+ },
+ "seasonTitleInternalAlias": {
+ "description": "Title used by involved parties to refer to this season.\nOnly available on TV Avails.\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
+ "priceValue": {
+ "description": "Value to be applied to the pricing type.\nExample: \"4\" or \"2.99\"",
+ "type": "string"
+ },
+ "episodeAltId": {
+ "description": "Other identifier referring to the episode, as defined by partner.\nOnly available on TV avails.\nExample: \"rs_googlers_s1_3\".",
+ "type": "string"
+ },
+ "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": {
+ "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": {
+ "description": "The number assigned to the season within a series.\nOnly available on TV Avails.\nExample: \"1\".",
+ "type": "string"
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ }
+ },
+ "id": "Avail",
+ "description": "An Avail describes the Availability Window of a specific Edit in a given\ncountry, which means the period Google is allowed to sell or rent the Edit.\n\nAvails are exposed in EMA format Version 1.6b (available at\nhttp://www.movielabs.com/md/avails/)\n\nStudios can see the Avails for the Titles they own.\nPost-production houses cannot see any Avails.",
+ "type": "object"
}
},
"icons": {
@@ -1027,5 +1016,16 @@
},
"servicePath": "",
"description": "Gets the delivery status of titles for Google Play Movies Partners.",
- "kind": "discovery#restDescription"
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://playmoviespartner.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "playmoviespartner",
+ "batchPath": "batch",
+ "revision": "20170822",
+ "id": "playmoviespartner:v1",
+ "documentationLink": "https://developers.google.com/playmoviespartner/",
+ "title": "Google Play Movies Partner API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/proximitybeacon/v1beta1/proximitybeacon-api.json b/proximitybeacon/v1beta1/proximitybeacon-api.json
index 8a65abd..23f2788 100644
--- a/proximitybeacon/v1beta1/proximitybeacon-api.json
+++ b/proximitybeacon/v1beta1/proximitybeacon-api.json
@@ -1,55 +1,47 @@
{
- "name": "proximitybeacon",
- "batchPath": "batch",
- "revision": "20170815",
- "documentationLink": "https://developers.google.com/beacons/proximity/",
- "id": "proximitybeacon:v1beta1",
- "title": "Google Proximity Beacon API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
"version_module": true,
"resources": {
"beaconinfo": {
"methods": {
"getforobserved": {
- "flatPath": "v1beta1/beaconinfo:getforobserved",
- "path": "v1beta1/beaconinfo:getforobserved",
- "id": "proximitybeacon.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"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "GetInfoForObservedBeaconsResponse"
},
- "parameters": {}
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "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"
+ }
}
}
},
"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",
"response": {
"$ref": "ListNamespacesResponse"
},
"parameterOrder": [],
- "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The project id to list namespaces under.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The project id to list namespaces under.\nOptional.",
- "type": "string"
- }
- },
"flatPath": "v1beta1/namespaces",
+ "path": "v1beta1/namespaces",
"id": "proximitybeacon.namespaces.list",
- "path": "v1beta1/namespaces"
+ "description": "Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
},
"update": {
"httpMethod": "PUT",
@@ -63,17 +55,17 @@
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
"parameters": {
- "namespaceName": {
- "location": "path",
- "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
- "type": "string",
- "required": true,
- "pattern": "^namespaces/[^/]+$"
- },
"projectId": {
"location": "query",
"description": "The project id of the namespace to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
"type": "string"
+ },
+ "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",
+ "required": true,
+ "pattern": "^namespaces/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1beta1/namespaces/{namespacesId}",
@@ -89,293 +81,49 @@
"v1beta1": {
"methods": {
"getEidparams": {
- "flatPath": "v1beta1/eidparams",
- "id": "proximitybeacon.getEidparams",
- "path": "v1beta1/eidparams",
- "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.",
+ "httpMethod": "GET",
"response": {
"$ref": "EphemeralIdRegistrationParams"
},
"parameterOrder": [],
- "httpMethod": "GET",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
+ ],
+ "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": {
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "id": "proximitybeacon.beacons.get",
- "path": "v1beta1/{+beaconName}",
- "description": "Returns detailed information about the specified beacon.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.\n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon. The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. Clients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast will receive an error.",
- "response": {
- "$ref": "Beacon"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "beaconName": {
- "location": "path",
- "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "update": {
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "id": "proximitybeacon.beacons.update",
- "path": "v1beta1/{+beaconName}",
- "request": {
- "$ref": "Beacon"
- },
- "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "response": {
- "$ref": "Beacon"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string"
- },
- "beaconName": {
- "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- }
- }
- },
- "decommission": {
- "description": "Decommissions the specified beacon in the service. This beacon will no\nlonger be returned from `beaconinfo.getforobserved`. This operation is\npermanent -- you will not be able to re-register a beacon with this ID\nagain.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "beaconName": {
- "location": "path",
- "description": "Beacon that should be decommissioned. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID of the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
- "id": "proximitybeacon.beacons.decommission",
- "path": "v1beta1/{+beaconName}:decommission"
- },
- "delete": {
- "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "projectId": {
- "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
- "type": "string",
- "location": "query"
- },
- "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.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.delete"
- },
- "deactivate": {
- "flatPath": "v1beta1/beacons/{beaconsId}:deactivate",
- "id": "proximitybeacon.beacons.deactivate",
- "path": "v1beta1/{+beaconName}:deactivate",
- "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "The project id of the beacon to deactivate. If the project id is not\nspecified then the project making the request is used. The project id must\nmatch the project that owns the beacon.\nOptional.",
- "type": "string",
- "location": "query"
- },
- "beaconName": {
- "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.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "register": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Beacon"
- },
- "parameters": {
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The project id of the project the beacon will be registered to. If\nthe project id is not specified then the project making the request\nis used.\nOptional."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons:register",
- "path": "v1beta1/beacons:register",
- "id": "proximitybeacon.beacons.register",
- "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "request": {
- "$ref": "Beacon"
- }
- },
- "list": {
- "response": {
- "$ref": "ListBeaconsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A pagination token obtained from a previous request to list beacons."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.",
- "type": "integer"
- },
- "q": {
- "location": "query",
- "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
- "type": "string"
- },
- "projectId": {
- "description": "The project id to list beacons under. If not present then the project\ncredential that made the request is used as the project.\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons",
- "id": "proximitybeacon.beacons.list",
- "path": "v1beta1/beacons",
- "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": {
- "description": "Activates a beacon. A beacon that is active will return information\nand attachment data when queried via `beaconinfo.getforobserved`.\nCalling this method on an already active beacon will do nothing (but\nwill return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "beaconName": {
- "type": "string",
- "required": true,
- "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."
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the beacon to activate. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}:activate",
- "id": "proximitybeacon.beacons.activate",
- "path": "v1beta1/{+beaconName}:activate"
- }
- },
"resources": {
"diagnostics": {
"methods": {
"list": {
+ "id": "proximitybeacon.beacons.diagnostics.list",
+ "path": "v1beta1/{+beaconName}/diagnostics",
"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",
"parameters": {
"beaconName": {
+ "pattern": "^beacons/[^/]+$",
"location": "path",
"description": "Beacon that the diagnostics are for.",
"type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$"
+ "required": true
},
"pageToken": {
- "location": "query",
"description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alertFilter": {
"location": "query",
@@ -394,123 +142,94 @@
"type": "integer"
},
"projectId": {
- "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional."
}
},
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
- "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
- "path": "v1beta1/{+beaconName}/diagnostics",
- "id": "proximitybeacon.beacons.diagnostics.list"
+ "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics"
}
}
},
"attachments": {
"methods": {
- "delete": {
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
- "id": "proximitybeacon.beacons.attachments.delete",
- "path": "v1beta1/{+attachmentName}",
- "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "attachmentName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "attachmentName": {
- "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\" Eddystone-UID.\nRequired.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+/attachments/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
"list": {
- "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.",
- "response": {
- "$ref": "ListBeaconAttachmentsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"beaconName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBeaconAttachmentsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
"parameters": {
- "namespacedType": {
+ "projectId": {
"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\".",
+ "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
"type": "string"
},
+ "namespacedType": {
+ "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": {
"description": "Beacon whose attachments should be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
"type": "string",
"required": true,
"pattern": "^beacons/[^/]+$",
"location": "path"
- },
- "projectId": {
- "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
- "type": "string",
- "location": "query"
}
},
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments"
+ "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."
},
"batchDelete": {
- "httpMethod": "POST",
- "parameterOrder": [
- "beaconName"
- ],
+ "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.",
"response": {
"$ref": "DeleteAttachmentsResponse"
},
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
"parameters": {
+ "namespacedType": {
+ "location": "query",
+ "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.",
+ "type": "string"
+ },
"beaconName": {
+ "location": "path",
"description": "The beacon whose attachments should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
"type": "string",
"required": true,
- "pattern": "^beacons/[^/]+$",
- "location": "path"
+ "pattern": "^beacons/[^/]+$"
},
"projectId": {
"location": "query",
"description": "The project id to delete beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
"type": "string"
- },
- "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"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete",
- "path": "v1beta1/{+beaconName}/attachments:batchDelete",
- "id": "proximitybeacon.beacons.attachments.batchDelete",
- "description": "Deletes multiple attachments on a given beacon. This operation is\npermanent and cannot be undone.\n\nYou can optionally specify `namespacedType` to choose which attachments\nshould be deleted. If you do not specify `namespacedType`, all your\nattachments on the given beacon will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
+ }
},
"create": {
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
+ "path": "v1beta1/{+beaconName}/attachments",
+ "id": "proximitybeacon.beacons.attachments.create",
"request": {
"$ref": "BeaconAttachment"
},
@@ -526,29 +245,320 @@
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
"parameters": {
- "beaconName": {
- "pattern": "^beacons/[^/]+$",
- "location": "path",
- "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true
- },
"projectId": {
"location": "query",
"description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.",
"type": "string"
+ },
+ "beaconName": {
+ "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "attachmentName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "attachmentName": {
+ "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\" Eddystone-UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+/attachments/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
- "path": "v1beta1/{+beaconName}/attachments",
- "id": "proximitybeacon.beacons.attachments.create"
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
+ "id": "proximitybeacon.beacons.attachments.delete",
+ "path": "v1beta1/{+attachmentName}"
}
}
}
+ },
+ "methods": {
+ "activate": {
+ "description": "Activates a beacon. A beacon that is active will return information\nand attachment data when queried via `beaconinfo.getforobserved`.\nCalling this method on an already active beacon will do nothing (but\nwill return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "parameters": {
+ "beaconName": {
+ "location": "path",
+ "description": "Beacon that should be activated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$"
+ },
+ "projectId": {
+ "type": "string",
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}:activate",
+ "path": "v1beta1/{+beaconName}:activate",
+ "id": "proximitybeacon.beacons.activate"
+ },
+ "get": {
+ "id": "proximitybeacon.beacons.get",
+ "path": "v1beta1/{+beaconName}",
+ "description": "Returns detailed information about the specified beacon.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.\n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon. The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. Clients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast will receive an error.",
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "beaconName": {
+ "location": "path",
+ "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$"
+ },
+ "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}"
+ },
+ "update": {
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "beaconName": {
+ "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "id": "proximitybeacon.beacons.update",
+ "path": "v1beta1/{+beaconName}",
+ "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "request": {
+ "$ref": "Beacon"
+ }
+ },
+ "decommission": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
+ "path": "v1beta1/{+beaconName}:decommission",
+ "id": "proximitybeacon.beacons.decommission",
+ "description": "Decommissions the specified beacon in the service. This beacon will no\nlonger be returned from `beaconinfo.getforobserved`. This operation is\npermanent -- you will not be able to re-register a beacon with this ID\nagain.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
+ },
+ "deactivate": {
+ "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "beaconName": {
+ "location": "path",
+ "description": "Beacon that should be deactivated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$"
+ },
+ "projectId": {
+ "description": "The project id of the beacon to deactivate. If the project id is not\nspecified then the project making the request is used. The project id must\nmatch the project that owns the beacon.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}:deactivate",
+ "id": "proximitybeacon.beacons.deactivate",
+ "path": "v1beta1/{+beaconName}:deactivate"
+ },
+ "delete": {
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "id": "proximitybeacon.beacons.delete",
+ "path": "v1beta1/{+beaconName}",
+ "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ "type": "string"
+ },
+ "beaconName": {
+ "description": "Beacon that should be deleted. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "register": {
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the project the beacon will be registered to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons:register",
+ "id": "proximitybeacon.beacons.register",
+ "path": "v1beta1/beacons:register",
+ "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "request": {
+ "$ref": "Beacon"
+ }
+ },
+ "list": {
+ "description": "Searches the beacon registry for beacons that match the given search\ncriteria. Only those beacons that the client has permission to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListBeaconsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A pagination token obtained from a previous request to list beacons.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.",
+ "type": "integer",
+ "location": "query"
+ },
+ "q": {
+ "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "description": "The project id to list beacons under. If not present then the project\ncredential that made the request is used as the project.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/beacons",
+ "path": "v1beta1/beacons",
+ "id": "proximitybeacon.beacons.list"
+ }
}
}
},
"parameters": {
+ "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",
@@ -565,41 +575,41 @@
"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"
},
+ "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",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "boolean"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -607,177 +617,25 @@
"default": "true",
"type": "boolean"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
- },
- "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"
}
},
"schemas": {
- "BeaconAttachment": {
- "description": "Project-specific data associated with a beacon.",
- "type": "object",
- "properties": {
- "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"
- },
- "data": {
- "type": "string",
- "format": "byte",
- "description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired."
- },
- "creationTimeMs": {
- "format": "google-datetime",
- "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.",
- "type": "string"
- }
- },
- "id": "BeaconAttachment"
- },
- "EphemeralIdRegistration": {
- "description": "Write-only registration parameters for beacons using Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon with the service\nare supported:\n\n1. Perform an ECDH key exchange via this API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity key, which becomes a secret between them.\n2. Derive or obtain the beacon's identity key via other secure means\n (perhaps an ECDH key exchange between the beacon and a mobile device\n or any other secure method), and then submit the resulting identity key\n to the service. In this case `beacon_identity_key` field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `service_ecdh_public_key` fields should be. The security of this method\n depends on how securely the parties involved (in particular the\n bluetooth client) handle the identity key, and obviously on how\n securely the identity key was generated.\n\nSee [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
- "type": "object",
- "properties": {
- "rotationPeriodExponent": {
- "format": "uint32",
- "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.",
- "type": "integer"
- },
- "serviceEcdhPublicKey": {
- "format": "byte",
- "description": "The service's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
- "type": "string"
- },
- "beaconIdentityKey": {
- "format": "byte",
- "description": "The private key of the beacon. If this field is populated,\n`beacon_ecdh_public_key` and `service_ecdh_public_key` must not be\npopulated.",
- "type": "string"
- },
- "initialEid": {
- "type": "string",
- "format": "byte",
- "description": "An initial ephemeral ID calculated using the clock value submitted as\n`initial_clock_value`, and the secret key generated by the\nDiffie-Hellman key exchange using `service_ecdh_public_key` and\n`service_ecdh_public_key`. This initial EID value will be used by the\nservice to confirm that the key exchange process was successful."
- },
- "initialClockValue": {
- "format": "uint64",
- "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
- "type": "string"
- },
- "beaconEcdhPublicKey": {
- "type": "string",
- "format": "byte",
- "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be."
- }
- },
- "id": "EphemeralIdRegistration"
- },
- "LatLng": {
- "id": "LatLng",
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
- "properties": {
- "longitude": {
- "format": "double",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "type": "number"
- },
- "latitude": {
- "format": "double",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "type": "number"
- }
- }
- },
- "ListBeaconAttachmentsResponse": {
- "description": "Response to `ListBeaconAttachments` that contains the requested attachments.",
- "type": "object",
- "properties": {
- "attachments": {
- "items": {
- "$ref": "BeaconAttachment"
- },
- "type": "array",
- "description": "The attachments that corresponded to the request params."
- }
- },
- "id": "ListBeaconAttachmentsResponse"
- },
- "Namespace": {
- "id": "Namespace",
- "description": "An attachment namespace defines read and write access for all the attachments\ncreated under it. Each namespace is globally unique, and owned by one\nproject which is the only project that can create attachments under it.",
- "type": "object",
- "properties": {
- "namespaceName": {
- "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
- "type": "string"
- },
- "servingVisibility": {
- "description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this value.",
- "Served only to the project that owns the namespace.",
- "Any project can subscribe to attachments under the namespace."
- ],
- "enum": [
- "VISIBILITY_UNSPECIFIED",
- "UNLISTED",
- "PUBLIC"
- ]
- }
- }
- },
- "AttachmentInfo": {
- "properties": {
- "data": {
- "format": "byte",
- "description": "An opaque data container for client-provided data.",
- "type": "string"
- },
- "namespacedType": {
- "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e, for\nexample \u003ccode\u003escrupulous-wombat-12345/welcome-message\u003c/code\u003e",
- "type": "string"
- }
- },
- "id": "AttachmentInfo",
- "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.",
- "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.",
"type": "object",
"properties": {
"beaconName": {
- "description": "The name under which the beacon is registered.",
- "type": "string"
+ "type": "string",
+ "description": "The name under which the beacon is registered."
},
"attachments": {
"description": "Attachments matching the type(s) requested.\nMay be empty if no attachment types were requested.",
@@ -793,20 +651,43 @@
},
"id": "BeaconInfo"
},
+ "AttachmentInfo": {
+ "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "format": "byte",
+ "description": "An opaque data container for client-provided data.",
+ "type": "string"
+ },
+ "namespacedType": {
+ "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e, for\nexample \u003ccode\u003escrupulous-wombat-12345/welcome-message\u003c/code\u003e",
+ "type": "string"
+ }
+ },
+ "id": "AttachmentInfo"
+ },
"DeleteAttachmentsResponse": {
"description": "Response for a request to delete attachments.",
"type": "object",
"properties": {
"numDeleted": {
- "type": "integer",
"format": "int32",
- "description": "The number of attachments that were deleted."
+ "description": "The number of attachments that were deleted.",
+ "type": "integer"
}
},
"id": "DeleteAttachmentsResponse"
},
"EphemeralIdRegistrationParams": {
+ "description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\nDiffie-Hellman key exchange. See\n[the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
+ "type": "object",
"properties": {
+ "serviceEcdhPublicKey": {
+ "type": "string",
+ "format": "byte",
+ "description": "The beacon service's public key for use by a beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exchange."
+ },
"maxRotationPeriodExponent": {
"format": "uint32",
"description": "Indicates the maximum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
@@ -816,16 +697,9 @@
"format": "uint32",
"description": "Indicates the minimum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
"type": "integer"
- },
- "serviceEcdhPublicKey": {
- "format": "byte",
- "description": "The beacon service's public key for use by a beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exchange.",
- "type": "string"
}
},
- "id": "EphemeralIdRegistrationParams",
- "description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\nDiffie-Hellman key exchange. See\n[the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
- "type": "object"
+ "id": "EphemeralIdRegistrationParams"
},
"Observation": {
"description": "Represents one beacon observed once.",
@@ -837,13 +711,13 @@
"type": "string"
},
"timestampMs": {
- "type": "string",
"format": "google-datetime",
- "description": "Time when the beacon was observed."
+ "description": "Time when the beacon was observed.",
+ "type": "string"
},
"advertisedId": {
- "$ref": "AdvertisedId",
- "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired."
+ "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired.",
+ "$ref": "AdvertisedId"
}
},
"id": "Observation"
@@ -852,16 +726,16 @@
"description": "Response that contains the requested diagnostics.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response."
+ },
"diagnostics": {
+ "description": "The diagnostics matching the given request.",
"items": {
"$ref": "Diagnostics"
},
- "type": "array",
- "description": "The diagnostics matching the given request."
- },
- "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"
+ "type": "array"
}
},
"id": "ListDiagnosticsResponse"
@@ -871,77 +745,37 @@
"type": "object",
"properties": {
"beacons": {
- "description": "Public information about beacons.\nMay be empty if the request matched no beacons.",
"items": {
"$ref": "BeaconInfo"
},
- "type": "array"
+ "type": "array",
+ "description": "Public information about beacons.\nMay be empty if the request matched no beacons."
}
},
"id": "GetInfoForObservedBeaconsResponse"
},
"Beacon": {
- "id": "Beacon",
"description": "Details of a beacon device.",
"type": "object",
"properties": {
- "beaconName": {
- "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
- "type": "string"
- },
- "expectedStability": {
- "enum": [
- "STABILITY_UNSPECIFIED",
- "STABLE",
- "PORTABLE",
- "MOBILE",
- "ROVING"
- ],
- "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this value.",
- "Not expected to move, for example a store's front door.",
- "Usually stable but may move rarely, usually within a single place,\nfor example a store display.",
- "Moves frequently, for example a personal item or food truck.",
- "Moves continuously in service, for example a bus or train."
- ]
- },
- "advertisedId": {
- "description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updating a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beacon that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddystone-UID that identifies the beacon and\nlinks it to its attachments. The stable Eddystone-UID is only used for\nadministering the beacon.",
- "$ref": "AdvertisedId"
- },
- "provisioningKey": {
- "format": "byte",
- "description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, transmit power).\nThis field provides a place to store and control access to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.",
- "type": "string"
- },
- "ephemeralIdRegistration": {
- "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error.",
- "$ref": "EphemeralIdRegistration"
- },
- "description": {
- "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
- "type": "string"
+ "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": {
- "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"
+ "description": {
+ "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
+ "type": "string"
},
"properties": {
- "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
- },
- "indoorLevel": {
- "$ref": "IndoorLevel",
- "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional."
+ },
+ "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
+ "type": "object"
},
"status": {
"enumDescriptions": [
@@ -958,19 +792,60 @@
],
"description": "Current status of the beacon.\nRequired.",
"type": "string"
- }
- }
- },
- "AdvertisedId": {
- "description": "Defines a unique identifier of a beacon as broadcast by the device.",
- "type": "object",
- "properties": {
- "id": {
- "format": "byte",
- "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.",
+ },
+ "indoorLevel": {
+ "$ref": "IndoorLevel",
+ "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional."
+ },
+ "beaconName": {
+ "type": "string",
+ "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."
+ },
+ "expectedStability": {
+ "enumDescriptions": [
+ "Do not use this value.",
+ "Not expected to move, for example a store's front door.",
+ "Usually stable but may move rarely, usually within a single place,\nfor example a store display.",
+ "Moves frequently, for example a personal item or food truck.",
+ "Moves continuously in service, for example a bus or train."
+ ],
+ "enum": [
+ "STABILITY_UNSPECIFIED",
+ "STABLE",
+ "PORTABLE",
+ "MOBILE",
+ "ROVING"
+ ],
+ "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
"type": "string"
},
+ "advertisedId": {
+ "description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updating a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beacon that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddystone-UID that identifies the beacon and\nlinks it to its attachments. The stable Eddystone-UID is only used for\nadministering the beacon.",
+ "$ref": "AdvertisedId"
+ },
+ "provisioningKey": {
+ "format": "byte",
+ "description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, transmit power).\nThis field provides a place to store and control access to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.",
+ "type": "string"
+ },
+ "ephemeralIdRegistration": {
+ "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error.",
+ "$ref": "EphemeralIdRegistration"
+ }
+ },
+ "id": "Beacon"
+ },
+ "AdvertisedId": {
+ "type": "object",
+ "properties": {
"type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "EDDYSTONE",
+ "IBEACON",
+ "ALTBEACON",
+ "EDDYSTONE_EID"
+ ],
"description": "Specifies the identifier type.\nRequired.",
"type": "string",
"enumDescriptions": [
@@ -979,33 +854,37 @@
"Apple iBeacon compatible beacon",
"See http://altbeacon.org and/or https://github.com/AltBeacon/spec.",
"Eddystone Ephemeral ID"
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "EDDYSTONE",
- "IBEACON",
- "ALTBEACON",
- "EDDYSTONE_EID"
]
+ },
+ "id": {
+ "type": "string",
+ "format": "byte",
+ "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."
}
},
- "id": "AdvertisedId"
+ "id": "AdvertisedId",
+ "description": "Defines a unique identifier of a beacon as broadcast by the device."
},
"IndoorLevel": {
- "description": "Indoor level, a human-readable string as returned by Google Maps APIs,\nuseful to indicate which floor of a building a beacon is located on.",
"type": "object",
"properties": {
"name": {
- "description": "The name of this level.",
- "type": "string"
+ "type": "string",
+ "description": "The name of this level."
}
},
- "id": "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."
},
"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",
+ "format": "int32",
+ "description": "Month of year. Must be from 1 to 12."
+ },
"day": {
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
@@ -1015,39 +894,57 @@
"format": "int32",
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"type": "integer"
- },
- "month": {
- "format": "int32",
- "description": "Month of year. Must be from 1 to 12.",
- "type": "integer"
}
},
"id": "Date"
},
"ListNamespacesResponse": {
+ "id": "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.",
"items": {
"$ref": "Namespace"
},
+ "type": "array",
+ "description": "The attachments that corresponded to the request params."
+ }
+ }
+ },
+ "ListBeaconsResponse": {
+ "description": "Response that contains list beacon results and pagination help.",
+ "type": "object",
+ "properties": {
+ "totalCount": {
+ "format": "int64",
+ "description": "Estimate of the total number of beacons matched by the query. Higher\nvalues may be less accurate.",
+ "type": "string"
+ },
+ "beacons": {
+ "description": "The beacons that matched the search criteria.",
+ "items": {
+ "$ref": "Beacon"
+ },
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "An opaque pagination token that the client may provide in their next\nrequest to retrieve the next page of results.",
+ "type": "string"
}
},
- "id": "ListNamespacesResponse"
+ "id": "ListBeaconsResponse"
},
"Diagnostics": {
+ "id": "Diagnostics",
"description": "Diagnostics for a single beacon.",
"type": "object",
"properties": {
"beaconName": {
- "type": "string",
- "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."
+ "description": "Resource name of the beacon. For Eddystone-EID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Eddystone-UID.",
+ "type": "string"
},
"alerts": {
- "description": "An unordered list of Alerts that the beacon has.",
"items": {
"enum": [
"ALERT_UNSPECIFIED",
@@ -1061,64 +958,159 @@
"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."
},
"estimatedLowBatteryDate": {
- "$ref": "Date",
- "description": "The date when the battery is expected to be low. If the value is missing\nthen there is no estimate for when the battery will be low.\nThis value is only an estimate, not an exact date."
+ "description": "The date when the battery is expected to be low. If the value is missing\nthen there is no estimate for when the battery will be low.\nThis value is only an estimate, not an exact date.",
+ "$ref": "Date"
}
- },
- "id": "Diagnostics"
- },
- "ListBeaconsResponse": {
- "description": "Response that contains list beacon results and pagination help.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "An opaque pagination token that the client may provide in their next\nrequest to retrieve the next page of results.",
- "type": "string"
- },
- "totalCount": {
- "format": "int64",
- "description": "Estimate of the total number of beacons matched by the query. Higher\nvalues may be less accurate.",
- "type": "string"
- },
- "beacons": {
- "description": "The beacons that matched the search criteria.",
- "items": {
- "$ref": "Beacon"
- },
- "type": "array"
- }
- },
- "id": "ListBeaconsResponse"
+ }
},
"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.",
- "items": {
- "$ref": "Observation"
- },
- "type": "array"
- },
"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.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "observations": {
+ "description": "The beacons that the client has encountered.\nAt least one must be given.",
+ "items": {
+ "$ref": "Observation"
+ },
+ "type": "array"
}
},
"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"
+ "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"
+ },
+ "BeaconAttachment": {
+ "type": "object",
+ "properties": {
+ "creationTimeMs": {
+ "format": "google-datetime",
+ "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.",
+ "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"
+ },
+ "data": {
+ "format": "byte",
+ "description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired.",
+ "type": "string"
+ }
+ },
+ "id": "BeaconAttachment",
+ "description": "Project-specific data associated with a beacon."
+ },
+ "EphemeralIdRegistration": {
+ "description": "Write-only registration parameters for beacons using Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon with the service\nare supported:\n\n1. Perform an ECDH key exchange via this API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity key, which becomes a secret between them.\n2. Derive or obtain the beacon's identity key via other secure means\n (perhaps an ECDH key exchange between the beacon and a mobile device\n or any other secure method), and then submit the resulting identity key\n to the service. In this case `beacon_identity_key` field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `service_ecdh_public_key` fields should be. The security of this method\n depends on how securely the parties involved (in particular the\n bluetooth client) handle the identity key, and obviously on how\n securely the identity key was generated.\n\nSee [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
+ "type": "object",
+ "properties": {
+ "beaconEcdhPublicKey": {
+ "type": "string",
+ "format": "byte",
+ "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be."
+ },
+ "initialClockValue": {
+ "format": "uint64",
+ "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
+ "type": "string"
+ },
+ "rotationPeriodExponent": {
+ "format": "uint32",
+ "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.",
+ "type": "integer"
+ },
+ "serviceEcdhPublicKey": {
+ "format": "byte",
+ "description": "The service's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
+ "type": "string"
+ },
+ "beaconIdentityKey": {
+ "type": "string",
+ "format": "byte",
+ "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."
+ },
+ "initialEid": {
+ "format": "byte",
+ "description": "An initial ephemeral ID calculated using the clock value submitted as\n`initial_clock_value`, and the secret key generated by the\nDiffie-Hellman key exchange using `service_ecdh_public_key` and\n`service_ecdh_public_key`. This initial EID value will be used by the\nservice to confirm that the key exchange process was successful.",
+ "type": "string"
+ }
+ },
+ "id": "EphemeralIdRegistration"
+ },
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object",
+ "properties": {
+ "longitude": {
+ "format": "double",
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "type": "number"
+ },
+ "latitude": {
+ "format": "double",
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "type": "number"
+ }
+ },
+ "id": "LatLng"
+ },
+ "ListBeaconAttachmentsResponse": {
+ "id": "ListBeaconAttachmentsResponse",
+ "description": "Response to `ListBeaconAttachments` that contains the requested attachments.",
+ "type": "object",
+ "properties": {
+ "attachments": {
+ "description": "The attachments that corresponded to the request params.",
+ "items": {
+ "$ref": "BeaconAttachment"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "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": {
+ "servingVisibility": {
+ "enumDescriptions": [
+ "Do not use this value.",
+ "Served only to the project that owns the namespace.",
+ "Any project can subscribe to attachments under the namespace."
+ ],
+ "enum": [
+ "VISIBILITY_UNSPECIFIED",
+ "UNLISTED",
+ "PUBLIC"
+ ],
+ "description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.",
+ "type": "string"
+ },
+ "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"
}
},
"protocol": "rest",
@@ -1137,10 +1129,18 @@
}
}
},
- "servicePath": "",
"description": "Registers, manages, indexes, and searches beacons.",
"kind": "discovery#restDescription",
+ "servicePath": "",
"rootUrl": "https://proximitybeacon.googleapis.com/",
"basePath": "",
- "ownerDomain": "google.com"
+ "ownerDomain": "google.com",
+ "name": "proximitybeacon",
+ "batchPath": "batch",
+ "id": "proximitybeacon:v1beta1",
+ "documentationLink": "https://developers.google.com/beacons/proximity/",
+ "revision": "20170823",
+ "title": "Google Proximity Beacon API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json
index 42b7b87..8acb53f 100644
--- a/pubsub/v1/pubsub-api.json
+++ b/pubsub/v1/pubsub-api.json
@@ -1,14 +1,12 @@
{
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"projects": {
"resources": {
"snapshots": {
"methods": {
"setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"response": {
"$ref": "Policy"
},
@@ -22,16 +20,20 @@
],
"parameters": {
"resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/snapshots/[^/]+$",
- "location": "path"
+ "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/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
"id": "pubsub.projects.snapshots.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
},
"testIamPermissions": {
"httpMethod": "POST",
@@ -41,6 +43,10 @@
"response": {
"$ref": "TestIamPermissionsResponse"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"resource": {
"location": "path",
@@ -50,132 +56,59 @@
"pattern": "^projects/[^/]+/snapshots/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
"id": "pubsub.projects.snapshots.testIamPermissions",
- "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."
},
"getIamPolicy": {
- "id": "pubsub.projects.snapshots.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"resource"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/snapshots/[^/]+$",
- "location": "path"
+ "required": true
}
},
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.snapshots.getIamPolicy"
}
}
},
"subscriptions": {
"methods": {
- "list": {
- "description": "Lists matching subscriptions.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListSubscriptionsResponse"
+ "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"
},
- "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 `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",
- "format": "int32",
- "description": "Maximum number of subscriptions to return.",
- "type": "integer"
- },
- "project": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`."
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions",
- "path": "v1/{+project}/subscriptions",
- "id": "pubsub.projects.subscriptions.list"
- },
- "setIamPolicy": {
"httpMethod": "POST",
"parameterOrder": [
- "resource"
+ "subscription"
],
"response": {
- "$ref": "Policy"
+ "$ref": "Empty"
},
"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.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "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"
- }
- },
- "create": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.create",
- "path": "v1/{+name}",
- "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request.",
- "request": {
- "$ref": "Subscription"
- },
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "subscription": {
+ "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
@@ -185,46 +118,75 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ]
- },
- "getIamPolicy": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "pubsub.projects.subscriptions.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ]
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
+ "path": "v1/{+subscription}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge"
},
"modifyAckDeadline": {
"request": {
"$ref": "ModifyAckDeadlineRequest"
},
"description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
"response": {
"$ref": "Empty"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
+ "path": "v1/{+subscription}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline"
+ },
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "description": "Gets the configuration details of a subscription.",
+ "response": {
+ "$ref": "Subscription"
+ },
"parameterOrder": [
"subscription"
],
- "httpMethod": "POST",
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
@@ -233,27 +195,33 @@
"subscription": {
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path",
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"type": "string",
"required": true
}
},
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline",
- "path": "v1/{+subscription}:modifyAckDeadline"
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.get",
+ "path": "v1/{+subscription}"
},
- "acknowledge": {
+ "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"
+ },
"response": {
- "$ref": "Empty"
+ "$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
- "subscription"
+ "resource"
],
"httpMethod": "POST",
"parameters": {
- "subscription": {
+ "resource": {
"location": "path",
- "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/subscriptions/[^/]+$"
@@ -263,76 +231,16 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
- "id": "pubsub.projects.subscriptions.acknowledge",
- "path": "v1/{+subscription}:acknowledge",
- "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
- "request": {
- "$ref": "AcknowledgeRequest"
- }
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1/{+subscription}",
- "id": "pubsub.projects.subscriptions.get",
- "description": "Gets the configuration details of a subscription."
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "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 detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "pubsub.projects.subscriptions.testIamPermissions"
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions"
},
"modifyPushConfig": {
+ "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"
},
- "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
"response": {
"$ref": "Empty"
},
@@ -340,48 +248,25 @@
"subscription"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
"subscription": {
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`."
}
},
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig"
- },
- "delete": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "type": "string",
- "required": true
- }
- },
- "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.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
]
},
"pull": {
+ "request": {
+ "$ref": "PullRequest"
+ },
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
"response": {
"$ref": "PullResponse"
},
@@ -404,38 +289,181 @@
},
"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."
- }
- }
- },
- "topics": {
- "methods": {
- "get": {
- "description": "Gets the configuration of a topic.",
- "httpMethod": "GET",
+ "path": "v1/{+subscription}:pull"
+ },
+ "delete": {
+ "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.",
+ "httpMethod": "DELETE",
"parameterOrder": [
- "topic"
+ "subscription"
],
"response": {
- "$ref": "Topic"
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "format": "int32",
+ "description": "Maximum number of subscriptions to return.",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "flatPath": "v1/projects/{projectsId}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list",
+ "path": "v1/{+project}/subscriptions",
+ "description": "Lists matching subscriptions."
+ },
+ "setIamPolicy": {
"parameters": {
- "topic": {
+ "resource": {
"location": "path",
- "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$"
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST"
+ },
+ "create": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1/{+name}",
+ "id": "pubsub.projects.subscriptions.create",
+ "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request.",
+ "request": {
+ "$ref": "Subscription"
+ }
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
+ "id": "pubsub.projects.topics.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "description": "Gets the configuration of a topic.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "parameters": {
+ "topic": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
"path": "v1/{+topic}",
"id": "pubsub.projects.topics.get"
@@ -448,10 +476,6 @@
"response": {
"$ref": "PublishResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
"topic": {
"description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
@@ -461,18 +485,19 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish",
"path": "v1/{+topic}:publish",
"id": "pubsub.projects.topics.publish",
+ "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
"request": {
"$ref": "PublishRequest"
- },
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute."
+ }
},
"testIamPermissions": {
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions",
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
@@ -486,17 +511,20 @@
},
"parameters": {
"resource": {
+ "location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.topics.testIamPermissions"
},
"delete": {
"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_`.",
@@ -507,10 +535,105 @@
"topic"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"topic": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
"description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
"type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
+ "id": "pubsub.projects.topics.delete",
+ "path": "v1/{+topic}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of topics to return.",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics",
+ "id": "pubsub.projects.topics.list",
+ "path": "v1/{+project}/topics",
+ "description": "Lists matching topics."
+ },
+ "create": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1/{+name}",
+ "id": "pubsub.projects.topics.create",
+ "description": "Creates the given topic with the given name.",
+ "request": {
+ "$ref": "Topic"
+ }
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
"required": true,
"pattern": "^projects/[^/]+/topics/[^/]+$",
"location": "path"
@@ -520,148 +643,20 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.delete",
- "path": "v1/{+topic}"
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/topics",
- "path": "v1/{+project}/topics",
- "id": "pubsub.projects.topics.list",
- "description": "Lists matching topics.",
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameters": {
- "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."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of topics to return.",
- "type": "integer"
- },
- "project": {
- "location": "path",
- "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "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": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$"
- }
- },
"flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
"path": "v1/{+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": {
- "request": {
- "$ref": "Topic"
- },
- "description": "Creates the given topic with the given name.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Topic"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "path": "v1/{+name}",
- "id": "pubsub.projects.topics.create"
- },
- "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.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
- }
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy"
+ "id": "pubsub.projects.topics.setIamPolicy"
}
},
"resources": {
"subscriptions": {
"methods": {
"list": {
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "GET",
"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"
+ "location": "query",
+ "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data."
},
"pageSize": {
"format": "int32",
@@ -670,11 +665,11 @@
"location": "query"
},
"topic": {
+ "type": "string",
+ "required": true,
"pattern": "^projects/[^/]+/topics/[^/]+$",
"location": "path",
- "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
- "type": "string",
- "required": true
+ "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`."
}
},
"scopes": [
@@ -684,7 +679,14 @@
"flatPath": "v1/projects/{projectsId}/topics/{topicsId}/subscriptions",
"id": "pubsub.projects.topics.subscriptions.list",
"path": "v1/{+topic}/subscriptions",
- "description": "Lists the name of the subscriptions for this topic."
+ "description": "Lists the name of the subscriptions for this topic.",
+ "response": {
+ "$ref": "ListTopicSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET"
}
}
}
@@ -694,11 +696,47 @@
}
},
"parameters": {
- "prettyPrint": {
+ "access_token": {
"location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"uploadType": {
"location": "query",
@@ -710,11 +748,6 @@
"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",
@@ -728,12 +761,12 @@
"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",
@@ -742,47 +775,161 @@
"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."
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "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"
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ]
}
},
"schemas": {
+ "ModifyAckDeadlineRequest": {
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object",
+ "properties": {
+ "ackIds": {
+ "description": "List of acknowledgment IDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "ackDeadlineSeconds": {
+ "type": "integer",
+ "format": "int32",
+ "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)."
+ }
+ },
+ "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": {
+ "messageId": {
+ "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
+ "type": "string"
+ },
+ "attributes": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional attributes for this message.",
+ "type": "object"
+ },
+ "publishTime": {
+ "format": "google-datetime",
+ "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
+ "type": "string"
+ },
+ "data": {
+ "format": "byte",
+ "description": "The message payload.",
+ "type": "string"
+ }
+ },
+ "id": "PubsubMessage"
+ },
+ "ModifyPushConfigRequest": {
+ "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",
+ "description": "Request for the ModifyPushConfig method."
+ },
+ "Binding": {
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ }
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AcknowledgeRequest"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "ListTopicsResponse": {
+ "description": "Response for the `ListTopics` method.",
+ "type": "object",
+ "properties": {
+ "topics": {
+ "description": "The resulting topics.",
+ "items": {
+ "$ref": "Topic"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
+ "type": "string"
+ }
+ },
+ "id": "ListTopicsResponse"
+ },
+ "ListTopicSubscriptionsResponse": {
+ "description": "Response for the `ListTopicSubscriptions` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListTopicSubscriptionsRequest` to get more subscriptions.",
+ "type": "string"
+ },
+ "subscriptions": {
+ "description": "The names of the subscriptions that match the request.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListTopicSubscriptionsResponse"
+ },
"PullResponse": {
+ "id": "PullResponse",
+ "description": "Response for the `Pull` method.",
"type": "object",
"properties": {
"receivedMessages": {
@@ -792,39 +939,37 @@
},
"type": "array"
}
- },
- "id": "PullResponse",
- "description": "Response for the `Pull` method."
+ }
},
"ReceivedMessage": {
- "id": "ReceivedMessage",
- "description": "A message and its corresponding acknowledgment ID.",
"type": "object",
"properties": {
"message": {
- "$ref": "PubsubMessage",
- "description": "The message."
+ "description": "The message.",
+ "$ref": "PubsubMessage"
},
"ackId": {
"description": "This ID can be used to acknowledge the received message.",
"type": "string"
}
- }
+ },
+ "id": "ReceivedMessage",
+ "description": "A message and its corresponding acknowledgment ID."
},
"PushConfig": {
"description": "Configuration for a push delivery endpoint.",
"type": "object",
"properties": {
"attributes": {
+ "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
- "type": "object"
+ }
},
"pushEndpoint": {
- "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\".",
- "type": "string"
+ "type": "string",
+ "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\"."
}
},
"id": "PushConfig"
@@ -847,19 +992,20 @@
"description": "Request for the `Pull` method.",
"type": "object",
"properties": {
+ "returnImmediately": {
+ "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.",
+ "type": "boolean"
+ },
"maxMessages": {
"format": "int32",
"description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
"type": "integer"
- },
- "returnImmediately": {
- "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.",
- "type": "boolean"
}
},
"id": "PullRequest"
},
"ListSubscriptionsResponse": {
+ "id": "ListSubscriptionsResponse",
"description": "Response for the `ListSubscriptions` method.",
"type": "object",
"properties": {
@@ -874,8 +1020,7 @@
},
"type": "array"
}
- },
- "id": "ListSubscriptionsResponse"
+ }
},
"PublishRequest": {
"description": "Request for the Publish method.",
@@ -892,7 +1037,6 @@
"id": "PublishRequest"
},
"PublishResponse": {
- "description": "Response for the `Publish` method.",
"type": "object",
"properties": {
"messageIds": {
@@ -903,7 +1047,8 @@
"type": "array"
}
},
- "id": "PublishResponse"
+ "id": "PublishResponse",
+ "description": "Response for the `Publish` method."
},
"Subscription": {
"description": "A subscription resource.",
@@ -923,8 +1068,8 @@
"type": "string"
},
"topic": {
- "description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
- "type": "string"
+ "type": "string",
+ "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."
}
},
"id": "Subscription"
@@ -943,16 +1088,19 @@
},
"id": "TestIamPermissionsRequest"
},
- "Policy": {
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "Topic": {
+ "description": "A topic resource.",
"type": "object",
"properties": {
- "etag": {
- "format": "byte",
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "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": {
"version": {
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
@@ -964,169 +1112,23 @@
"$ref": "Binding"
},
"type": "array"
- }
- }
- },
- "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": {
- "ackDeadlineSeconds": {
- "format": "int32",
- "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).",
- "type": "integer"
},
- "ackIds": {
- "description": "List of acknowledgment IDs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "ModifyAckDeadlineRequest"
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "SetIamPolicyRequest"
- },
- "ModifyPushConfigRequest": {
- "description": "Request for the ModifyPushConfig method.",
- "type": "object",
- "properties": {
- "pushConfig": {
- "$ref": "PushConfig",
- "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called."
- }
- },
- "id": "ModifyPushConfigRequest"
- },
- "PubsubMessage": {
- "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
- "type": "object",
- "properties": {
- "messageId": {
- "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
- "type": "string"
- },
- "attributes": {
- "description": "Optional attributes for this message.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "publishTime": {
- "format": "google-datetime",
- "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
- "type": "string"
- },
- "data": {
+ "etag": {
"format": "byte",
- "description": "The message payload.",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"type": "string"
}
},
- "id": "PubsubMessage"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "ListTopicsResponse": {
- "description": "Response for the `ListTopics` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
- "type": "string"
- },
- "topics": {
- "items": {
- "$ref": "Topic"
- },
- "type": "array",
- "description": "The resulting topics."
- }
- },
- "id": "ListTopicsResponse"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "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"
- },
- "AcknowledgeRequest": {
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "AcknowledgeRequest",
- "description": "Request for the Acknowledge method."
- },
- "ListTopicSubscriptionsResponse": {
- "description": "Response for the `ListTopicSubscriptions` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListTopicSubscriptionsRequest` to get more subscriptions.",
- "type": "string"
- },
- "subscriptions": {
- "description": "The names of the subscriptions that match the request.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "ListTopicSubscriptionsResponse"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"version": "v1",
"baseUrl": "https://pubsub.googleapis.com/",
"canonicalName": "Pubsub",
@@ -1142,18 +1144,16 @@
}
}
},
- "servicePath": "",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
"kind": "discovery#restDescription",
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
+ "servicePath": "",
"rootUrl": "https://pubsub.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "pubsub",
"batchPath": "batch",
- "revision": "20170814",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
"id": "pubsub:v1",
- "title": "Google Cloud Pub/Sub API",
- "ownerName": "Google",
- "discoveryVersion": "v1"
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "revision": "20170814",
+ "title": "Google Cloud Pub/Sub API"
}
diff --git a/pubsub/v1beta1a/pubsub-api.json b/pubsub/v1beta1a/pubsub-api.json
index 2d74d47..22a4809 100644
--- a/pubsub/v1beta1a/pubsub-api.json
+++ b/pubsub/v1beta1a/pubsub-api.json
@@ -4,67 +4,116 @@
"resources": {
"subscriptions": {
"methods": {
- "acknowledge": {
- "description": "Acknowledges a particular received message: the Pub/Sub system can remove\nthe given message from the subscription. Acknowledging a message whose\nAck deadline has expired may succeed, but the message could have been\nalready redelivered. Acknowledging a message more than once will not\nresult in an error. This is only used for messages received via pull.",
- "request": {
- "$ref": "AcknowledgeRequest"
- },
+ "list": {
+ "description": "Lists matching subscriptions.",
"response": {
- "$ref": "Empty"
+ "$ref": "ListSubscriptionsResponse"
},
"parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
+ "httpMethod": "GET",
+ "parameters": {
+ "maxResults": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of subscriptions to return.",
+ "type": "integer"
+ },
+ "query": {
+ "location": "query",
+ "description": "A valid label query expression.",
+ "type": "string"
+ },
+ "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/acknowledge",
- "id": "pubsub.subscriptions.acknowledge",
- "path": "v1beta1a/subscriptions/acknowledge"
+ "flatPath": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.list",
+ "path": "v1beta1a/subscriptions"
},
- "modifyAckDeadline": {
+ "create": {
"httpMethod": "POST",
"parameterOrder": [],
"response": {
+ "$ref": "Subscription"
+ },
+ "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",
+ "request": {
+ "$ref": "Subscription"
+ },
+ "description": "Creates a subscription on a given topic for a given subscriber.\nIf the subscription already exists, returns ALREADY_EXISTS.\nIf the corresponding topic doesn't exist, returns NOT_FOUND.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic."
+ },
+ "modifyAckDeadline": {
+ "response": {
"$ref": "Empty"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {},
"flatPath": "v1beta1a/subscriptions/modifyAckDeadline",
- "path": "v1beta1a/subscriptions/modifyAckDeadline",
"id": "pubsub.subscriptions.modifyAckDeadline",
+ "path": "v1beta1a/subscriptions/modifyAckDeadline",
"request": {
"$ref": "ModifyAckDeadlineRequest"
},
"description": "Modifies the Ack deadline for a message received from a pull request."
},
- "pullBatch": {
+ "acknowledge": {
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ },
+ "description": "Acknowledges a particular received message: the Pub/Sub system can remove\nthe given message from the subscription. Acknowledging a message whose\nAck deadline has expired may succeed, but the message could have been\nalready redelivered. Acknowledging a message more than once will not\nresult in an error. This is only used for messages received via pull.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
- "$ref": "PullBatchResponse"
+ "$ref": "Empty"
},
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "parameters": {},
+ "flatPath": "v1beta1a/subscriptions/acknowledge",
+ "path": "v1beta1a/subscriptions/acknowledge",
+ "id": "pubsub.subscriptions.acknowledge"
+ },
+ "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.",
+ "path": "v1beta1a/subscriptions/pullBatch",
"request": {
"$ref": "PullBatchRequest"
- }
+ },
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The system is free to return UNAVAILABLE\nif there are too many pull requests outstanding for the given subscription.",
+ "response": {
+ "$ref": "PullBatchResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {}
},
"get": {
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
- "id": "pubsub.subscriptions.get",
- "path": "v1beta1a/subscriptions/{+subscription}",
"description": "Gets the configuration details of a subscription.",
"response": {
"$ref": "Subscription"
@@ -73,39 +122,68 @@
"subscription"
],
"httpMethod": "GET",
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription to get.",
+ "type": "string",
+ "required": true,
+ "pattern": "^.+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {
- "subscription": {
- "pattern": "^.+$",
- "location": "path",
- "description": "The name of the subscription to get.",
- "type": "string",
- "required": true
- }
- }
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "id": "pubsub.subscriptions.get",
+ "path": "v1beta1a/subscriptions/{+subscription}"
},
"modifyPushConfig": {
"flatPath": "v1beta1a/subscriptions/modifyPushConfig",
- "path": "v1beta1a/subscriptions/modifyPushConfig",
"id": "pubsub.subscriptions.modifyPushConfig",
+ "path": "v1beta1a/subscriptions/modifyPushConfig",
"request": {
"$ref": "ModifyPushConfigRequest"
},
"description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {}
},
+ "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",
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to delete.",
+ "type": "string",
+ "required": true,
+ "pattern": "^.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "id": "pubsub.subscriptions.delete",
+ "path": "v1beta1a/subscriptions/{+subscription}"
+ },
"pull": {
"response": {
"$ref": "PullResponse"
@@ -124,76 +202,47 @@
"$ref": "PullRequest"
},
"description": "Pulls a single message from the server.\nIf return_immediately is true, and no messages are available in the\nsubscription, this method returns FAILED_PRECONDITION. The system is free\nto return an UNAVAILABLE error if no messages are available in a\nreasonable amount of time (to reduce system load)."
- },
- "delete": {
- "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND.",
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "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": "Empty"
+ "$ref": "Topic"
},
"parameterOrder": [
- "subscription"
+ "topic"
],
- "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.",
- "type": "string",
- "required": true,
- "pattern": "^.+$"
- }
- },
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
- "id": "pubsub.subscriptions.delete",
- "path": "v1beta1a/subscriptions/{+subscription}"
- },
- "list": {
- "description": "Lists matching subscriptions.",
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
- "pageToken": {
- "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.",
+ "topic": {
+ "location": "path",
+ "description": "The name of the topic to get.",
"type": "string",
- "location": "query"
- },
- "maxResults": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of subscriptions to return.",
- "type": "integer"
- },
- "query": {
- "type": "string",
- "location": "query",
- "description": "A valid label query expression."
+ "required": true,
+ "pattern": "^.+$"
}
},
- "flatPath": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.list",
- "path": "v1beta1a/subscriptions"
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "id": "pubsub.topics.get",
+ "path": "v1beta1a/topics/{+topic}"
},
- "create": {
- "flatPath": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.create",
- "path": "v1beta1a/subscriptions",
+ "publish": {
+ "flatPath": "v1beta1a/topics/publish",
+ "id": "pubsub.topics.publish",
+ "path": "v1beta1a/topics/publish",
"request": {
- "$ref": "Subscription"
+ "$ref": "PublishRequest"
},
- "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.",
+ "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
"response": {
- "$ref": "Subscription"
+ "$ref": "Empty"
},
"parameterOrder": [],
"httpMethod": "POST",
@@ -202,42 +251,15 @@
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {}
- }
- }
- },
- "topics": {
- "methods": {
- "publish": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics/publish",
- "path": "v1beta1a/topics/publish",
- "id": "pubsub.topics.publish",
- "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
- "request": {
- "$ref": "PublishRequest"
- }
},
"delete": {
- "flatPath": "v1beta1a/topics/{topicsId}",
- "id": "pubsub.topics.delete",
- "path": "v1beta1a/topics/{+topic}",
- "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name.",
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"topic"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
@@ -250,16 +272,13 @@
"pattern": "^.+$",
"location": "path"
}
- }
+ },
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "path": "v1beta1a/topics/{+topic}",
+ "id": "pubsub.topics.delete",
+ "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name."
},
"publishBatch": {
- "flatPath": "v1beta1a/topics/publishBatch",
- "id": "pubsub.topics.publishBatch",
- "path": "v1beta1a/topics/publishBatch",
- "request": {
- "$ref": "PublishBatchRequest"
- },
- "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.",
"response": {
"$ref": "PublishBatchResponse"
},
@@ -269,40 +288,47 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {}
+ "parameters": {},
+ "flatPath": "v1beta1a/topics/publishBatch",
+ "id": "pubsub.topics.publishBatch",
+ "path": "v1beta1a/topics/publishBatch",
+ "request": {
+ "$ref": "PublishBatchRequest"
+ },
+ "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist."
},
"list": {
- "flatPath": "v1beta1a/topics",
- "id": "pubsub.topics.list",
- "path": "v1beta1a/topics",
- "description": "Lists matching topics.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
"response": {
"$ref": "ListTopicsResponse"
},
- "parameterOrder": [],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
"pageToken": {
- "location": "query",
"description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string"
- },
- "maxResults": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of topics to return.",
- "type": "integer"
- },
- "query": {
- "description": "A valid label query expression.",
"type": "string",
"location": "query"
+ },
+ "maxResults": {
+ "format": "int32",
+ "description": "Maximum number of topics to return.",
+ "type": "integer",
+ "location": "query"
+ },
+ "query": {
+ "location": "query",
+ "description": "A valid label query expression.",
+ "type": "string"
}
- }
+ },
+ "flatPath": "v1beta1a/topics",
+ "path": "v1beta1a/topics",
+ "id": "pubsub.topics.list",
+ "description": "Lists matching topics."
},
"create": {
"response": {
@@ -322,63 +348,26 @@
"$ref": "Topic"
},
"description": "Creates the given topic with the given name."
- },
- "get": {
- "flatPath": "v1beta1a/topics/{topicsId}",
- "id": "pubsub.topics.get",
- "path": "v1beta1a/topics/{+topic}",
- "description": "Gets the configuration of a topic. Since the topic only has the name\nattribute, this method is only useful to check the existence of a topic.\nIf other attributes are added in the future, they will be returned here.",
- "response": {
- "$ref": "Topic"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "topic"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "topic": {
- "type": "string",
- "required": true,
- "pattern": "^.+$",
- "location": "path",
- "description": "The name of the topic to get."
- }
- }
}
}
}
},
"parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "callback": {
- "description": "JSONP",
+ "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",
@@ -393,12 +382,6 @@
]
},
"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": [
@@ -406,51 +389,202 @@
"media",
"proto"
],
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
"location": "query"
},
- "access_token": {
+ "key": {
"location": "query",
- "description": "OAuth access token.",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
+ "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": {
- "default": "true",
- "type": "boolean",
"location": "query",
- "description": "Pretty-print response."
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
- "bearer_token": {
- "type": "string",
+ "upload_protocol": {
"location": "query",
- "description": "OAuth bearer token."
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
}
},
"schemas": {
- "ModifyAckDeadlineRequest": {
+ "PullRequest": {
+ "description": "Request for the Pull method.",
"type": "object",
"properties": {
- "ackIds": {
- "description": "List of acknowledgment IDs. Either this field or ack_id\nshould be populated, not both.",
+ "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": {
+ "subscription": {
+ "description": "The subscription that received the event.",
+ "type": "string"
+ },
+ "deleted": {
+ "description": "Indicates that this subscription has been deleted. (Note that pull\nsubscribers will always receive NOT_FOUND in response in their pull\nrequest on the subscription, rather than seeing this boolean.)",
+ "type": "boolean"
+ },
+ "truncated": {
+ "description": "Indicates that this subscription has been truncated.",
+ "type": "boolean"
+ },
+ "message": {
+ "$ref": "PubsubMessage",
+ "description": "A received message."
+ }
+ },
+ "id": "PubsubEvent"
+ },
+ "ListSubscriptionsResponse": {
+ "description": "Response for the ListSubscriptions method.",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "description": "The subscriptions that match the request.",
+ "items": {
+ "$ref": "Subscription"
+ },
+ "type": "array"
+ },
+ "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": {
+ "format": "int32",
+ "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).",
+ "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.",
"items": {
"type": "string"
},
"type": "array"
+ }
+ },
+ "id": "PublishBatchResponse"
+ },
+ "Topic": {
+ "description": "A topic resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the topic.",
+ "type": "string"
+ }
+ },
+ "id": "Topic"
+ },
+ "Label": {
+ "description": "A key-value pair applied to a given object.",
+ "type": "object",
+ "properties": {
+ "strValue": {
+ "description": "A string value.",
+ "type": "string"
},
+ "numValue": {
+ "format": "int64",
+ "description": "An integer value.",
+ "type": "string"
+ },
+ "key": {
+ "description": "The key of a label is a syntactically valid URL (as per RFC 1738) with\nthe \"scheme\" and initial slashes omitted and with the additional\nrestrictions noted below. Each key should be globally unique. The\n\"host\" portion is called the \"namespace\" and is not necessarily\nresolvable to a network endpoint. Instead, the namespace indicates what\nsystem or entity defines the semantics of the label. Namespaces do not\nrestrict the set of objects to which a label may be associated.\n\nKeys are defined by the following grammar:\n\n key = hostname \"/\" kpath\n kpath = ksegment *[ \"/\" ksegment ]\n ksegment = alphadigit | *[ alphadigit | \"-\" | \"_\" | \".\" ]\n\nwhere \"hostname\" and \"alphadigit\" are defined as in RFC 1738.\n\nExample key:\n spanner.google.com/universe",
+ "type": "string"
+ }
+ },
+ "id": "Label"
+ },
+ "ModifyAckDeadlineRequest": {
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object",
+ "properties": {
"subscription": {
"description": "Next Index: 5\nThe name of the subscription from which messages are being pulled.",
"type": "string"
@@ -463,63 +597,64 @@
"format": "int32",
"description": "The new ack deadline with respect to the time this request was sent to the\nPub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new ack\ndeadline will expire 10 seconds after the ModifyAckDeadline call was made.\nSpecifying zero may immediately make the message available for another pull\nrequest.",
"type": "integer"
+ },
+ "ackIds": {
+ "description": "List of acknowledgment IDs. Either this field or ack_id\nshould be populated, not both.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method."
+ "id": "ModifyAckDeadlineRequest"
},
"PullBatchRequest": {
- "id": "PullBatchRequest",
"description": "Request for the PullBatch method.",
"type": "object",
"properties": {
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.",
+ "type": "string"
+ },
"returnImmediately": {
- "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."
+ "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": {
"format": "int32",
"description": "The maximum number of PubsubEvents returned for this request. The Pub/Sub\nsystem may return fewer than the number of events specified.",
"type": "integer"
- },
- "subscription": {
- "description": "The subscription from which messages should be pulled.",
- "type": "string"
}
- }
+ },
+ "id": "PullBatchRequest"
},
"ModifyPushConfigRequest": {
+ "description": "Request for the ModifyPushConfig method.",
"type": "object",
"properties": {
- "pushConfig": {
- "description": "An empty \u003ccode\u003epush_config\u003c/code\u003e indicates that the Pub/Sub system should\npause pushing messages from the given subscription.",
- "$ref": "PushConfig"
- },
"subscription": {
"description": "The name of the subscription.",
"type": "string"
+ },
+ "pushConfig": {
+ "description": "An empty \u003ccode\u003epush_config\u003c/code\u003e indicates that the Pub/Sub system should\npause pushing messages from the given subscription.",
+ "$ref": "PushConfig"
}
},
- "id": "ModifyPushConfigRequest",
- "description": "Request for the ModifyPushConfig method."
+ "id": "ModifyPushConfigRequest"
},
"PubsubMessage": {
"description": "A message data and its labels.",
"type": "object",
"properties": {
- "data": {
- "format": "byte",
- "description": "The message payload.",
- "type": "string"
- },
"messageId": {
"description": "ID of this message assigned by the server at publication time. Guaranteed\nto be unique within the topic. This value may be read by a subscriber\nthat receives a PubsubMessage via a Pull call or a push delivery. It must\nnot be populated by a publisher in a Publish call.",
"type": "string"
},
"publishTime": {
- "type": "string",
"format": "int64",
- "description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch."
+ "description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch.",
+ "type": "string"
},
"label": {
"description": "Optional list of labels for this message. Keys in this collection must\nbe unique.",
@@ -527,15 +662,32 @@
"$ref": "Label"
},
"type": "array"
+ },
+ "data": {
+ "format": "byte",
+ "description": "The message payload.",
+ "type": "string"
}
},
"id": "PubsubMessage"
},
- "Empty": {
- "description": "An empty message that you can re-use to avoid defining duplicated empty\nmessages in your project. A typical example is to use it as argument or the\nreturn value of a service API. For instance:\n\n service Foo {\n rpc Bar (proto2.Empty) returns (proto2.Empty) { };\n };\n\nBEGIN GOOGLE-INTERNAL\nThe difference between this one and net/rpc/empty-message.proto is that\n1) The generated message here is in proto2 C++ API.\n2) The proto2.Empty has minimum dependencies\n (no message_set or net/rpc dependencies)\nEND GOOGLE-INTERNAL",
+ "ListTopicsResponse": {
+ "description": "Response for the ListTopics method.",
"type": "object",
- "properties": {},
- "id": "Empty"
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there are more topics that match the request,\nand this value should be passed to the next \u003ccode\u003eListTopicsRequest\u003c/code\u003e\nto continue.",
+ "type": "string"
+ },
+ "topic": {
+ "description": "The resulting topics.",
+ "items": {
+ "$ref": "Topic"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListTopicsResponse"
},
"PublishBatchRequest": {
"description": "Request for the PublishBatch method.",
@@ -555,23 +707,11 @@
},
"id": "PublishBatchRequest"
},
- "ListTopicsResponse": {
+ "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": {
- "topic": {
- "description": "The resulting topics.",
- "items": {
- "$ref": "Topic"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "If not empty, indicates that there are more topics that match the request,\nand this value should be passed to the next \u003ccode\u003eListTopicsRequest\u003c/code\u003e\nto continue.",
- "type": "string"
- }
- },
- "id": "ListTopicsResponse",
- "description": "Response for the ListTopics method."
+ "properties": {},
+ "id": "Empty"
},
"PullBatchResponse": {
"description": "Response for the PullBatch method.",
@@ -606,6 +746,7 @@
"id": "AcknowledgeRequest"
},
"PullResponse": {
+ "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated.",
"type": "object",
"properties": {
"ackId": {
@@ -613,12 +754,11 @@
"type": "string"
},
"pubsubEvent": {
- "$ref": "PubsubEvent",
- "description": "A pubsub message or truncation event."
+ "description": "A pubsub message or truncation event.",
+ "$ref": "PubsubEvent"
}
},
- "id": "PullResponse",
- "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated."
+ "id": "PullResponse"
},
"PushConfig": {
"description": "Configuration for a push delivery endpoint.",
@@ -630,152 +770,12 @@
}
},
"id": "PushConfig"
- },
- "PullRequest": {
- "id": "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"
- }
- }
- },
- "PubsubEvent": {
- "description": "An event indicating a received message or truncation event.",
- "type": "object",
- "properties": {
- "deleted": {
- "type": "boolean",
- "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.)"
- },
- "truncated": {
- "description": "Indicates that this subscription has been truncated.",
- "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.",
- "items": {
- "$ref": "Subscription"
- },
- "type": "array"
- },
- "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": {
- "message": {
- "$ref": "PubsubMessage",
- "description": "The message to publish."
- },
- "topic": {
- "description": "The message in the request will be published on this topic.",
- "type": "string"
- }
- },
- "id": "PublishRequest"
- },
- "Subscription": {
- "description": "A subscription resource.",
- "type": "object",
- "properties": {
- "ackDeadlineSeconds": {
- "type": "integer",
- "format": "int32",
- "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)."
- },
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "PublishBatchResponse"
- },
- "Topic": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the topic.",
- "type": "string"
- }
- },
- "id": "Topic",
- "description": "A topic resource."
- },
- "Label": {
- "description": "A key-value pair applied to a given object.",
- "type": "object",
- "properties": {
- "strValue": {
- "description": "A string value.",
- "type": "string"
- },
- "numValue": {
- "format": "int64",
- "description": "An integer value.",
- "type": "string"
- },
- "key": {
- "description": "The key of a label is a syntactically valid URL (as per RFC 1738) with\nthe \"scheme\" and initial slashes omitted and with the additional\nrestrictions noted below. Each key should be globally unique. The\n\"host\" portion is called the \"namespace\" and is not necessarily\nresolvable to a network endpoint. Instead, the namespace indicates what\nsystem or entity defines the semantics of the label. Namespaces do not\nrestrict the set of objects to which a label may be associated.\n\nKeys are defined by the following grammar:\n\n key = hostname \"/\" kpath\n kpath = ksegment *[ \"/\" ksegment ]\n ksegment = alphadigit | *[ alphadigit | \"-\" | \"_\" | \".\" ]\n\nwhere \"hostname\" and \"alphadigit\" are defined as in RFC 1738.\n\nExample key:\n spanner.google.com/universe",
- "type": "string"
- }
- },
- "id": "Label"
}
},
"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": "v1beta1a",
"baseUrl": "https://pubsub.googleapis.com/",
@@ -783,11 +783,11 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/pubsub": {
"description": "View and manage Pub/Sub topics and subscriptions"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -800,7 +800,7 @@
"ownerDomain": "google.com",
"name": "pubsub",
"batchPath": "batch",
- "revision": "20170814",
+ "revision": "20170731",
"documentationLink": "https://cloud.google.com/pubsub/docs",
"id": "pubsub:v1beta1a",
"title": "Google Cloud Pub/Sub API"
diff --git a/pubsub/v1beta2/pubsub-api.json b/pubsub/v1beta2/pubsub-api.json
index ef5ad8a..17cf592 100644
--- a/pubsub/v1beta2/pubsub-api.json
+++ b/pubsub/v1beta2/pubsub-api.json
@@ -1,11 +1,30 @@
{
+ "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": "20170814",
"id": "pubsub:v1beta2",
"documentationLink": "https://cloud.google.com/pubsub/docs",
+ "revision": "20170731",
"title": "Google Cloud Pub/Sub API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -14,146 +33,9 @@
"resources": {
"subscriptions": {
"methods": {
- "acknowledge": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription whose message is being acknowledged.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
- "id": "pubsub.projects.subscriptions.acknowledge",
- "path": "v1beta2/{+subscription}:acknowledge",
- "request": {
- "$ref": "AcknowledgeRequest"
- },
- "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST"
- },
- "modifyAckDeadline": {
- "path": "v1beta2/{+subscription}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline",
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
- },
- "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
- "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.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline"
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy",
- "id": "pubsub.projects.subscriptions.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "id": "pubsub.projects.subscriptions.get",
- "path": "v1beta2/{+subscription}",
- "description": "Gets the configuration details of a subscription.",
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription to get.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}"
- },
- "testIamPermissions": {
- "id": "pubsub.projects.subscriptions.testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}: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"
@@ -167,89 +49,91 @@
"httpMethod": "POST",
"parameters": {
"subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
"description": "The name of the subscription.",
"type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.modifyPushConfig",
- "path": "v1beta2/{+subscription}:modifyPushConfig"
- },
- "pull": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription from which messages should be pulled.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
- "path": "v1beta2/{+subscription}:pull",
- "id": "pubsub.projects.subscriptions.pull",
- "request": {
- "$ref": "PullRequest"
- },
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "PullResponse"
- }
- },
- "delete": {
- "id": "pubsub.projects.subscriptions.delete",
- "path": "v1beta2/{+subscription}",
- "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription, or its topic unless the same topic is specified.",
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The subscription to delete.",
- "type": "string",
"required": true,
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig"
+ },
+ "delete": {
+ "path": "v1beta2/{+subscription}",
+ "id": "pubsub.projects.subscriptions.delete",
+ "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription, or its topic unless the same topic is specified.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The subscription to delete.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}"
},
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "PullResponse"
+ },
+ "parameters": {
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
+ "path": "v1beta2/{+subscription}:pull",
+ "id": "pubsub.projects.subscriptions.pull"
+ },
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListSubscriptionsResponse"
},
"parameterOrder": [
"project"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"pageToken": {
+ "location": "query",
"description": "The value returned by the last `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"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -258,10 +142,32 @@
"type": "integer"
},
"project": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
"description": "The name of the cloud project that subscriptions belong to.",
"type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list",
+ "path": "v1beta2/{+project}/subscriptions",
+ "description": "Lists matching subscriptions."
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
"required": true,
- "pattern": "^projects/[^/]+$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path"
}
},
@@ -269,12 +175,17 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
- "path": "v1beta2/{+project}/subscriptions",
- "id": "pubsub.projects.subscriptions.list",
- "description": "Lists matching subscriptions."
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
},
"create": {
+ "id": "pubsub.projects.subscriptions.create",
+ "path": "v1beta2/{+name}",
"request": {
"$ref": "Subscription"
},
@@ -292,24 +203,128 @@
],
"parameters": {
"name": {
+ "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}"
+ },
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "modifyAckDeadline": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "description": "The name of the subscription.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
+ "path": "v1beta2/{+subscription}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline",
+ "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
+ "request": {
+ "$ref": "ModifyAckDeadlineRequest"
+ }
+ },
+ "acknowledge": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path",
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "description": "The subscription whose message is being acknowledged.",
"type": "string",
"required": true
}
},
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.create",
- "path": "v1beta2/{+name}"
- },
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
+ "path": "v1beta2/{+subscription}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
"request": {
- "$ref": "SetIamPolicyRequest"
+ "$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."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "subscription"
+ ],
"response": {
- "$ref": "Policy"
+ "$ref": "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1beta2/{+subscription}",
+ "id": "pubsub.projects.subscriptions.get",
+ "description": "Gets the configuration details of a subscription."
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
"resource"
@@ -319,7 +334,7 @@
"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.",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true
}
@@ -328,76 +343,46 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
- "id": "pubsub.projects.subscriptions.setIamPolicy",
- "path": "v1beta2/{+resource}:setIamPolicy"
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
+ "id": "pubsub.projects.subscriptions.testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
}
}
},
"topics": {
"methods": {
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "Name of the topic to delete.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.delete",
- "path": "v1beta2/{+topic}",
- "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.",
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
+ "create": {
+ "httpMethod": "PUT",
"parameterOrder": [
- "topic"
- ]
- },
- "list": {
- "description": "Lists matching topics.",
+ "name"
+ ],
"response": {
- "$ref": "ListTopicsResponse"
+ "$ref": "Topic"
},
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of topics to return.",
- "type": "integer",
- "location": "query"
- },
- "project": {
- "description": "The name of the cloud project that topics belong to.",
+ "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",
"required": true,
- "pattern": "^projects/[^/]+$",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/topics",
- "id": "pubsub.projects.topics.list",
- "path": "v1beta2/{+project}/topics"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1beta2/{+name}",
+ "id": "pubsub.projects.topics.create",
+ "description": "Creates the given topic with the given name.",
+ "request": {
+ "$ref": "Topic"
+ }
},
"setIamPolicy": {
"httpMethod": "POST",
@@ -428,35 +413,6 @@
"$ref": "SetIamPolicyRequest"
}
},
- "create": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Topic"
- },
- "parameters": {
- "name": {
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "path": "v1beta2/{+name}",
- "id": "pubsub.projects.topics.create",
- "description": "Creates the given topic with the given name.",
- "request": {
- "$ref": "Topic"
- }
- },
"getIamPolicy": {
"id": "pubsub.projects.topics.getIamPolicy",
"path": "v1beta2/{+resource}:getIamPolicy",
@@ -464,69 +420,59 @@
"response": {
"$ref": "Policy"
},
+ "httpMethod": "GET",
"parameterOrder": [
"resource"
],
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy"
},
"get": {
- "parameters": {
- "topic": {
- "description": "The name of the topic to get.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
+ "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.",
+ "type": "string",
+ "required": true
+ }
+ },
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
"path": "v1beta2/{+topic}",
"id": "pubsub.projects.topics.get",
- "description": "Gets the configuration of a topic.",
- "httpMethod": "GET",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "Topic"
- }
+ "description": "Gets the configuration of a topic."
},
"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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "topic"
- ],
"response": {
"$ref": "PublishResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
+ "parameterOrder": [
+ "topic"
],
+ "httpMethod": "POST",
"parameters": {
"topic": {
"pattern": "^projects/[^/]+/topics/[^/]+$",
@@ -536,16 +482,26 @@
"required": true
}
},
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish"
+ "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",
+ "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": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "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.",
@@ -560,53 +516,116 @@
"https://www.googleapis.com/auth/pubsub"
],
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions",
"path": "v1beta2/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.topics.testIamPermissions",
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
}
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "topic": {
+ "description": "Name of the topic to delete.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "id": "pubsub.projects.topics.delete",
+ "path": "v1beta2/{+topic}",
+ "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`."
+ },
+ "list": {
+ "description": "Lists matching topics.",
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of topics to return.",
+ "type": "integer"
+ },
+ "project": {
+ "description": "The name of the cloud project that topics belong to.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics",
+ "id": "pubsub.projects.topics.list",
+ "path": "v1beta2/{+project}/topics"
}
},
"resources": {
"subscriptions": {
"methods": {
"list": {
+ "response": {
+ "$ref": "ListTopicSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
+ "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",
+ "format": "int32",
+ "description": "Maximum number of subscription names to return.",
+ "type": "integer"
+ },
+ "topic": {
+ "description": "The name of the topic that subscriptions are attached to.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
"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": {
- "format": "int32",
- "description": "Maximum number of subscription names to return.",
- "type": "integer",
- "location": "query"
- },
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic that subscriptions are attached to.",
- "type": "string",
- "required": true
- }
- },
"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.",
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "topic"
- ]
+ "description": "Lists the name of the subscriptions for this topic."
}
}
}
@@ -616,51 +635,43 @@
}
},
"parameters": {
- "quotaUser": {
+ "oauth_token": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "boolean",
+ "location": "query"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "$.xgafv": {
- "description": "V1 error format.",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -669,16 +680,11 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -690,23 +696,48 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "access_token": {
- "description": "OAuth access token.",
+ "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"
}
},
"schemas": {
+ "PublishRequest": {
+ "properties": {
+ "messages": {
+ "description": "The messages to publish.",
+ "items": {
+ "$ref": "PubsubMessage"
+ },
+ "type": "array"
+ }
+ },
+ "id": "PublishRequest",
+ "description": "Request for the Publish method.",
+ "type": "object"
+ },
"PublishResponse": {
- "description": "Response for the `Publish` method.",
- "type": "object",
"properties": {
"messageIds": {
"description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
@@ -716,20 +747,12 @@
"type": "array"
}
},
- "id": "PublishResponse"
+ "id": "PublishResponse",
+ "description": "Response for the `Publish` method.",
+ "type": "object"
},
"Subscription": {
- "description": "A subscription resource.",
- "type": "object",
"properties": {
- "name": {
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
- "type": "string"
- },
- "topic": {
- "description": "The name of the topic from which this subscription is receiving messages.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
- "type": "string"
- },
"pushConfig": {
"description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods.",
"$ref": "PushConfig"
@@ -738,12 +761,21 @@
"format": "int32",
"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.",
"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"
+ "id": "Subscription",
+ "description": "A subscription resource.",
+ "type": "object"
},
"TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -754,12 +786,29 @@
},
"type": "array"
}
- }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Topic": {
+ "properties": {
+ "name": {
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "type": "string"
+ }
+ },
+ "id": "Topic",
+ "description": "A topic resource.",
+ "type": "object"
},
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
+ "etag": {
+ "format": "byte",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "type": "string"
+ },
"version": {
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
@@ -771,38 +820,12 @@
"$ref": "Binding"
},
"type": "array"
- },
- "etag": {
- "format": "byte",
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "type": "string"
}
},
"id": "Policy"
},
- "Topic": {
- "description": "A topic resource.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
- "type": "string"
- }
- },
- "id": "Topic"
- },
"ModifyAckDeadlineRequest": {
- "id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method.",
- "type": "object",
"properties": {
- "ackIds": {
- "description": "List of acknowledgment IDs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"ackId": {
"description": "The acknowledgment ID. Either this or ack_ids must be populated, but not\nboth.",
"type": "string"
@@ -811,24 +834,54 @@
"format": "int32",
"description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.",
"type": "integer"
+ },
+ "ackIds": {
+ "description": "List of acknowledgment IDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
- }
+ },
+ "id": "ModifyAckDeadlineRequest",
+ "description": "Request for the ModifyAckDeadline 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."
+ "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.",
+ "ModifyPushConfigRequest": {
+ "description": "Request for the ModifyPushConfig method.",
"type": "object",
"properties": {
+ "pushConfig": {
+ "$ref": "PushConfig",
+ "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called."
+ }
+ },
+ "id": "ModifyPushConfigRequest"
+ },
+ "PubsubMessage": {
+ "properties": {
+ "messageId": {
+ "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
+ "type": "string"
+ },
+ "attributes": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional attributes for this message.",
+ "type": "object"
+ },
"publishTime": {
"format": "google-datetime",
"description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
@@ -838,35 +891,13 @@
"format": "byte",
"description": "The message payload. For JSON requests, the value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc4648).",
"type": "string"
- },
- "messageId": {
- "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
- "type": "string"
- },
- "attributes": {
- "description": "Optional attributes for this message.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
}
},
- "id": "PubsubMessage"
- },
- "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."
- }
- }
+ "id": "PubsubMessage",
+ "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
+ "type": "object"
},
"Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
"properties": {
"members": {
"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",
@@ -880,7 +911,33 @@
"type": "string"
}
},
- "id": "Binding"
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
+ },
+ "ListTopicsResponse": {
+ "description": "Response for the `ListTopics` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
+ "type": "string"
+ },
+ "topics": {
+ "description": "The resulting topics.",
+ "items": {
+ "$ref": "Topic"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListTopicsResponse"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
},
"AcknowledgeRequest": {
"description": "Request for the Acknowledge method.",
@@ -896,47 +953,23 @@
},
"id": "AcknowledgeRequest"
},
- "Empty": {
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {}
- },
- "ListTopicsResponse": {
- "id": "ListTopicsResponse",
- "description": "Response for the `ListTopics` method.",
- "type": "object",
+ "ListTopicSubscriptionsResponse": {
"properties": {
"nextPageToken": {
- "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
+ "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"
},
- "topics": {
- "description": "The resulting topics.",
- "items": {
- "$ref": "Topic"
- },
- "type": "array"
- }
- }
- },
- "ListTopicSubscriptionsResponse": {
- "id": "ListTopicSubscriptionsResponse",
- "description": "Response for the `ListTopicSubscriptions` method.",
- "type": "object",
- "properties": {
"subscriptions": {
"description": "The names of the subscriptions that match the request.",
"items": {
"type": "string"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListTopicSubscriptionsRequest` to get more subscriptions.",
- "type": "string"
}
- }
+ },
+ "id": "ListTopicSubscriptionsResponse",
+ "description": "Response for the `ListTopicSubscriptions` method.",
+ "type": "object"
},
"PullResponse": {
"description": "Response for the `Pull` method.",
@@ -953,40 +986,39 @@
"id": "PullResponse"
},
"ReceivedMessage": {
- "id": "ReceivedMessage",
- "description": "A message and its corresponding acknowledgment ID.",
- "type": "object",
"properties": {
"message": {
- "description": "The message.",
- "$ref": "PubsubMessage"
+ "$ref": "PubsubMessage",
+ "description": "The message."
},
"ackId": {
"description": "This ID can be used to acknowledge the received message.",
"type": "string"
}
- }
+ },
+ "id": "ReceivedMessage",
+ "description": "A message and its corresponding acknowledgment ID.",
+ "type": "object"
},
"PushConfig": {
- "id": "PushConfig",
"description": "Configuration for a push delivery endpoint.",
"type": "object",
"properties": {
"attributes": {
- "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the push message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the envelope (i.e. its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the push message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the envelope (i.e. its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
+ "type": "object"
},
"pushEndpoint": {
"description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\".",
"type": "string"
}
- }
+ },
+ "id": "PushConfig"
},
"TestIamPermissionsResponse": {
- "id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -997,11 +1029,10 @@
},
"type": "array"
}
- }
+ },
+ "id": "TestIamPermissionsResponse"
},
"PullRequest": {
- "description": "Request for the `Pull` method.",
- "type": "object",
"properties": {
"returnImmediately": {
"description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the `Pull` response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
@@ -1013,7 +1044,9 @@
"type": "integer"
}
},
- "id": "PullRequest"
+ "id": "PullRequest",
+ "description": "Request for the `Pull` method.",
+ "type": "object"
},
"ListSubscriptionsResponse": {
"description": "Response for the `ListSubscriptions` method.",
@@ -1032,44 +1065,11 @@
}
},
"id": "ListSubscriptionsResponse"
- },
- "PublishRequest": {
- "description": "Request for the Publish method.",
- "type": "object",
- "properties": {
- "messages": {
- "description": "The messages to publish.",
- "items": {
- "$ref": "PubsubMessage"
- },
- "type": "array"
- }
- },
- "id": "PublishRequest"
}
},
- "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": "v1beta2",
- "baseUrl": "https://pubsub.googleapis.com/",
- "canonicalName": "Pubsub",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/pubsub": {
- "description": "View and manage Pub/Sub topics and subscriptions"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "servicePath": "",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
- "kind": "discovery#restDescription",
- "rootUrl": "https://pubsub.googleapis.com/"
+ "protocol": "rest"
}
diff --git a/runtimeconfig/v1/runtimeconfig-api.json b/runtimeconfig/v1/runtimeconfig-api.json
index 040e0b5..0dcdb83 100644
--- a/runtimeconfig/v1/runtimeconfig-api.json
+++ b/runtimeconfig/v1/runtimeconfig-api.json
@@ -1,31 +1,25 @@
{
"basePath": "",
- "id": "runtimeconfig:v1",
"revision": "20170816",
"documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "id": "runtimeconfig:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
- },
"CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
"type": "object",
"properties": {},
- "id": "CancelOperationRequest"
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation."
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"code": {
+ "type": "integer",
"format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
+ "description": "The status code, which should be an enum value of google.rpc.Code."
},
"message": {
"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.",
@@ -34,11 +28,11 @@
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "type": "object"
},
"type": "array"
}
@@ -70,49 +64,55 @@
"$ref": "Status"
},
"metadata": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
+ "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"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations."
+ },
+ "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"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Cloud RuntimeConfig",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloudruntimeconfig": {
- "description": "Manage your Google Cloud Platform services' runtime configuration"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloudruntimeconfig": {
+ "description": "Manage your Google Cloud Platform services' runtime configuration"
}
}
}
@@ -126,49 +126,11 @@
"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 allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "pattern": "^operations$",
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1/operations",
- "id": "runtimeconfig.operations.list",
- "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`.",
"response": {
"$ref": "Empty"
},
@@ -182,46 +144,84 @@
],
"parameters": {
"name": {
- "location": "path",
"description": "The name of the operation resource to be cancelled.",
"type": "string",
"required": true,
- "pattern": "^operations/.+$"
- }
- },
- "flatPath": "v1/operations/{operationsId}:cancel",
- "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`."
- },
- "delete": {
- "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`.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "type": "string",
- "required": true,
"pattern": "^operations/.+$",
"location": "path"
}
},
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "id": "runtimeconfig.operations.cancel",
+ "path": "v1/{+name}:cancel"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudruntimeconfig"
],
- "flatPath": "v1/operations/{operationsId}"
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "runtimeconfig.operations.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^operations$",
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1/operations",
+ "path": "v1/{+name}",
+ "id": "runtimeconfig.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
}
}
}
@@ -233,10 +233,10 @@
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"fields": {
"location": "query",
@@ -244,18 +244,11 @@
"type": "string"
},
"uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
"location": "query",
- "description": "JSONP",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -264,15 +257,16 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -280,12 +274,18 @@
"media",
"proto"
],
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"access_token": {
"description": "OAuth access token.",
@@ -303,15 +303,15 @@
"default": "true",
"type": "boolean"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
}
},
"version": "v1",
diff --git a/runtimeconfig/v1beta1/runtimeconfig-api.json b/runtimeconfig/v1beta1/runtimeconfig-api.json
index e6ea7af..66b827f 100644
--- a/runtimeconfig/v1beta1/runtimeconfig-api.json
+++ b/runtimeconfig/v1beta1/runtimeconfig-api.json
@@ -1,48 +1,40 @@
{
- "kind": "discovery#restDescription",
- "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
- "servicePath": "",
- "basePath": "",
- "id": "runtimeconfig:v1beta1",
- "revision": "20170816",
- "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
- "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": {
+ "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": {
- "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."
},
"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"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
@@ -59,11 +51,6 @@
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
@@ -71,20 +58,23 @@
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
- "type": "object",
"additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "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"
},
"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",
@@ -98,7 +88,25 @@
"type": "string"
}
},
- "id": "Binding"
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
+ },
+ "Cardinality": {
+ "properties": {
+ "number": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified."
+ },
+ "path": {
+ "description": "The root of the variable subtree to monitor. For example, `/foo`.",
+ "type": "string"
+ }
+ },
+ "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"
},
"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 `{}`.",
@@ -106,36 +114,20 @@
"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": {
- "number": {
- "format": "int32",
- "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.",
- "type": "integer"
- },
- "path": {
- "description": "The root of the variable subtree to monitor. For example, `/foo`.",
- "type": "string"
- }
- },
- "id": "Cardinality"
- },
"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": {
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
+ },
"configs": {
"description": "A list of the configurations in the project. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.",
"items": {
"$ref": "RuntimeConfig"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
- "type": "string"
}
},
"id": "ListConfigsResponse"
@@ -145,8 +137,8 @@
"type": "object",
"properties": {
"cardinality": {
- "description": "The cardinality of the `EndCondition`.",
- "$ref": "Cardinality"
+ "$ref": "Cardinality",
+ "description": "The cardinality of the `EndCondition`."
}
},
"id": "EndCondition"
@@ -169,16 +161,16 @@
"description": "Response for the `ListVariables()` method.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
+ },
"variables": {
"description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.",
"items": {
"$ref": "Variable"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
- "type": "string"
}
},
"id": "ListVariablesResponse"
@@ -199,34 +191,71 @@
"id": "RuntimeConfig"
},
"WatchVariableRequest": {
- "description": "Request for the `WatchVariable()` method.",
"type": "object",
"properties": {
"newerThan": {
+ "type": "string",
"format": "google-datetime",
- "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.",
- "type": "string"
+ "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."
}
},
- "id": "WatchVariableRequest"
+ "id": "WatchVariableRequest",
+ "description": "Request for the `WatchVariable()` method."
},
"ListWaitersResponse": {
- "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
- "type": "string"
- },
"waiters": {
"description": "Found waiters in the project.",
"items": {
"$ref": "Waiter"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
}
},
- "id": "ListWaitersResponse"
+ "id": "ListWaitersResponse",
+ "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary."
+ },
+ "Waiter": {
+ "properties": {
+ "error": {
+ "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set.",
+ "$ref": "Status"
+ },
+ "failure": {
+ "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout.",
+ "$ref": "EndCondition"
+ },
+ "success": {
+ "$ref": "EndCondition",
+ "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated."
+ },
+ "done": {
+ "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.",
+ "type": "string"
+ },
+ "timeout": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`."
+ },
+ "name": {
+ "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.",
+ "type": "string"
+ }
+ },
+ "id": "Waiter",
+ "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource\nto be met before it returns. For example, assume you have a distributed\nsystem where each node writes to a Variable resource indidicating the node's\nreadiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)\ndocumentation.",
+ "type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
@@ -242,56 +271,10 @@
},
"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.",
- "type": "object",
- "properties": {
- "error": {
- "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set.",
- "$ref": "Status"
- },
- "failure": {
- "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout.",
- "$ref": "EndCondition"
- },
- "success": {
- "$ref": "EndCondition",
- "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated."
- },
- "createTime": {
- "format": "google-datetime",
- "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.",
- "type": "string"
- },
- "done": {
- "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.",
- "type": "boolean"
- },
- "timeout": {
- "format": "google-duration",
- "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.",
- "type": "string"
- },
- "name": {
- "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.",
- "type": "string"
- }
- },
- "id": "Waiter"
- },
"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": {
- "text": {
- "description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.",
- "type": "string"
- },
- "value": {
- "format": "byte",
- "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
- "type": "string"
- },
"state": {
"enumDescriptions": [
"Default variable state.",
@@ -314,6 +297,15 @@
"name": {
"description": "The name of the variable resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\nvalid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system\nfile path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and\ndashes. Slashes are used as path element separators and are not part of the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nnon-slash character. Multiple slashes are coalesced into single slash\ncharacter. Each path segment should follow RFC 1035 segment specification.\nThe length of a `[VARIABLE_NAME]` must be less than 256 bytes.\n\nOnce you create a variable, you cannot change the variable name.",
"type": "string"
+ },
+ "text": {
+ "description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.",
+ "type": "string"
+ },
+ "value": {
+ "format": "byte",
+ "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
+ "type": "string"
}
},
"id": "Variable"
@@ -322,13 +314,6 @@
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "items": {
- "$ref": "Binding"
- },
- "type": "array"
- },
"etag": {
"format": "byte",
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
@@ -338,16 +323,23 @@
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
}
},
"id": "Policy"
}
},
+ "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": {
@@ -372,155 +364,7 @@
"resources": {
"configs": {
"methods": {
- "get": {
- "description": "Gets information about a RuntimeConfig resource.",
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "id": "runtimeconfig.projects.configs.get",
- "path": "v1beta1/{+name}"
- },
- "update": {
- "request": {
- "$ref": "RuntimeConfig"
- },
- "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.",
- "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]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.update"
- },
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.testIamPermissions"
- },
- "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]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "id": "runtimeconfig.projects.configs.delete",
- "path": "v1beta1/{+name}"
- },
- "list": {
- "flatPath": "v1beta1/projects/{projectsId}/configs",
- "id": "runtimeconfig.projects.configs.list",
- "path": "v1beta1/{+parent}/configs",
- "description": "Lists all the RuntimeConfig resources within project.",
- "response": {
- "$ref": "ListConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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": {
- "format": "int32",
- "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
"create": {
- "flatPath": "v1beta1/projects/{projectsId}/configs",
"id": "runtimeconfig.projects.configs.create",
"path": "v1beta1/{+parent}/configs",
"request": {
@@ -545,19 +389,16 @@
"location": "query"
},
"parent": {
- "location": "path",
- "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$"
+ "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]`."
}
- }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs"
},
"setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"response": {
"$ref": "Policy"
},
@@ -571,16 +412,20 @@
],
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
+ "required": true
}
},
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
"id": "runtimeconfig.projects.configs.setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy"
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
},
"getIamPolicy": {
"httpMethod": "GET",
@@ -592,11 +437,11 @@
},
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$"
+ "required": true
}
},
"scopes": [
@@ -607,11 +452,413 @@
"path": "v1beta1/{+resource}:getIamPolicy",
"id": "runtimeconfig.projects.configs.getIamPolicy",
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.get",
+ "description": "Gets information about a RuntimeConfig resource."
+ },
+ "update": {
+ "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.",
+ "request": {
+ "$ref": "RuntimeConfig"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.update"
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions"
+ },
+ "delete": {
+ "description": "Deletes a RuntimeConfig resource.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.delete"
+ },
+ "list": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs",
+ "id": "runtimeconfig.projects.configs.list",
+ "path": "v1beta1/{+parent}/configs",
+ "description": "Lists all the RuntimeConfig resources within project.",
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListConfigsResponse"
+ },
+ "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": {
+ "format": "int32",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ }
}
},
"resources": {
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Variable"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "requestId": {
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "description": "The path to the 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]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
+ "path": "v1beta1/{+parent}/variables",
+ "id": "runtimeconfig.projects.configs.variables.create"
+ },
+ "get": {
+ "description": "Gets information about a single variable.",
+ "httpMethod": "GET",
+ "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 return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.variables.get"
+ },
+ "watch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch",
+ "id": "runtimeconfig.projects.configs.variables.watch",
+ "path": "v1beta1/{+name}: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"
+ },
+ "update": {
+ "description": "Updates an existing variable with a new value.",
+ "request": {
+ "$ref": "Variable"
+ },
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "id": "runtimeconfig.projects.configs.variables.update",
+ "path": "v1beta1/{+name}"
+ },
+ "testIamPermissions": {
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.variables.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}: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": {
+ "recursive": {
+ "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "id": "runtimeconfig.projects.configs.variables.delete",
+ "path": "v1beta1/{+name}"
+ },
+ "list": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
+ "id": "runtimeconfig.projects.configs.variables.list",
+ "path": "v1beta1/{+parent}/variables",
+ "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned.",
+ "response": {
+ "$ref": "ListVariablesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The path to the 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]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path"
+ },
+ "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"
+ },
+ "returnValues": {
+ "location": "query",
+ "description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "type": "integer",
+ "location": "query"
+ }
+ }
+ }
+ }
+ },
"waiters": {
"methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.waiters.delete",
+ "description": "Deletes the waiter with the specified name."
+ },
"get": {
"response": {
"$ref": "Waiter"
@@ -639,9 +886,6 @@
"description": "Gets information about a single waiter."
},
"list": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
- "id": "runtimeconfig.projects.configs.waiters.list",
- "path": "v1beta1/{+parent}/waiters",
"description": "List waiters within the given configuration.",
"response": {
"$ref": "ListWaitersResponse"
@@ -651,6 +895,13 @@
],
"httpMethod": "GET",
"parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true
+ },
"pageToken": {
"location": "query",
"description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
@@ -661,35 +912,30 @@
"format": "int32",
"description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
"type": "integer"
- },
- "parent": {
- "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]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
+ "id": "runtimeconfig.projects.configs.waiters.list",
+ "path": "v1beta1/{+parent}/waiters"
},
"create": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
- "path": "v1beta1/{+parent}/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"
},
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudruntimeconfig"
@@ -701,215 +947,14 @@
"location": "query"
},
"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]`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$"
- }
- }
- },
- "testIamPermissions": {
- "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.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.waiters.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- },
- "delete": {
- "description": "Deletes the waiter with the specified name.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
- "location": "path"
- }
- },
- "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}"
- }
- }
- },
- "operations": {
- "methods": {
- "testIamPermissions": {
- "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.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.operations.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
- "id": "runtimeconfig.projects.configs.operations.get",
- "path": "v1beta1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- },
- "variables": {
- "methods": {
- "get": {
- "description": "Gets information about a single variable.",
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "id": "runtimeconfig.projects.configs.variables.get",
- "path": "v1beta1/{+name}"
- },
- "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"
- },
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "update": {
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "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]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "id": "runtimeconfig.projects.configs.variables.update",
- "path": "v1beta1/{+name}",
- "request": {
- "$ref": "Variable"
- },
- "description": "Updates an existing variable with a new value."
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters"
},
"testIamPermissions": {
"request": {
@@ -929,128 +974,75 @@
],
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
+ "required": true
}
},
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.variables.testIamPermissions",
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.waiters.testIamPermissions",
"path": "v1beta1/{+resource}:testIamPermissions"
- },
- "delete": {
+ }
+ }
+ },
+ "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": "Empty"
+ "$ref": "Operation"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
- "parameters": {
- "recursive": {
- "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
- "type": "boolean",
- "location": "query"
- },
- "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]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudruntimeconfig"
],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "id": "runtimeconfig.projects.configs.variables.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes a variable or multiple variables.\n\nIf you specify a variable name, then that variable is deleted. If you\nspecify a prefix and `recursive` is true, then all variables with that\nprefix are deleted. You must set a `recursive` to true if you delete\nvariables by prefix."
- },
- "list": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
- "path": "v1beta1/{+parent}/variables",
- "id": "runtimeconfig.projects.configs.variables.list",
- "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListVariablesResponse"
- },
"parameters": {
- "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"
- },
- "returnValues": {
- "location": "query",
- "description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.",
- "type": "boolean"
- },
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
- "type": "integer"
- },
- "parent": {
- "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]`",
+ "name": {
+ "description": "The name of the operation resource.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
"location": "path"
}
},
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
+ "id": "runtimeconfig.projects.configs.operations.get",
+ "path": "v1beta1/{+name}"
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
],
- "response": {
- "$ref": "Variable"
- },
"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 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]`",
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$"
+ "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}/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.",
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.operations.testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
"request": {
- "$ref": "Variable"
- }
+ "$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."
}
}
}
@@ -1060,51 +1052,23 @@
}
},
"parameters": {
- "pp": {
- "description": "Pretty-print response.",
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
"location": "query"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
"location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1113,40 +1077,76 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "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"
}
},
"version": "v1beta1",
- "baseUrl": "https://runtimeconfig.googleapis.com/"
+ "baseUrl": "https://runtimeconfig.googleapis.com/",
+ "servicePath": "",
+ "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "revision": "20170816",
+ "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "id": "runtimeconfig:v1beta1",
+ "discoveryVersion": "v1"
}
diff --git a/safebrowsing/v4/safebrowsing-api.json b/safebrowsing/v4/safebrowsing-api.json
index e749d25..59a9309 100644
--- a/safebrowsing/v4/safebrowsing-api.json
+++ b/safebrowsing/v4/safebrowsing-api.json
@@ -1,141 +1,46 @@
{
- "revision": "20170814",
- "documentationLink": "https://developers.google.com/safe-browsing/",
- "id": "safebrowsing:v4",
- "title": "Google Safe Browsing API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
- "threatListUpdates": {
- "methods": {
- "fetch": {
- "parameters": {},
- "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"
- },
- "response": {
- "$ref": "FetchThreatListUpdatesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- }
- }
- },
- "encodedFullHashes": {
- "methods": {
- "get": {
- "parameters": {
- "encodedRequest": {
- "location": "path",
- "format": "byte",
- "description": "A serialized FindFullHashesRequest proto.",
- "type": "string",
- "required": true
- },
- "clientId": {
- "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
- "type": "string",
- "location": "query"
- },
- "clientVersion": {
- "location": "query",
- "description": "The version of the client implementation.",
- "type": "string"
- }
- },
- "flatPath": "v4/encodedFullHashes/{encodedRequest}",
- "id": "safebrowsing.encodedFullHashes.get",
- "path": "v4/encodedFullHashes/{encodedRequest}",
- "description": "",
- "response": {
- "$ref": "FindFullHashesResponse"
- },
- "parameterOrder": [
- "encodedRequest"
- ],
- "httpMethod": "GET"
- }
- }
- },
- "threatLists": {
- "methods": {
- "list": {
- "parameters": {},
- "flatPath": "v4/threatLists",
- "id": "safebrowsing.threatLists.list",
- "path": "v4/threatLists",
- "description": "Lists the Safe Browsing threat lists available for download.",
- "response": {
- "$ref": "ListThreatListsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": []
- }
- }
- },
- "threatMatches": {
- "methods": {
- "find": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "FindThreatMatchesResponse"
- },
- "parameters": {},
- "flatPath": "v4/threatMatches:find",
- "path": "v4/threatMatches:find",
- "id": "safebrowsing.threatMatches.find",
- "request": {
- "$ref": "FindThreatMatchesRequest"
- },
- "description": "Finds the threat entries that match the Safe Browsing lists."
- }
- }
- },
"fullHashes": {
"methods": {
"find": {
- "parameters": {},
- "flatPath": "v4/fullHashes:find",
- "id": "safebrowsing.fullHashes.find",
- "path": "v4/fullHashes:find",
- "description": "Finds the full hashes that match the requested hash prefixes.",
"request": {
"$ref": "FindFullHashesRequest"
},
+ "description": "Finds the full hashes that match the requested hash prefixes.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "FindFullHashesResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST"
+ "parameters": {},
+ "flatPath": "v4/fullHashes:find",
+ "path": "v4/fullHashes:find",
+ "id": "safebrowsing.fullHashes.find"
}
}
},
"encodedUpdates": {
"methods": {
"get": {
- "description": "",
"httpMethod": "GET",
- "parameterOrder": [
- "encodedRequest"
- ],
"response": {
"$ref": "FetchThreatListUpdatesResponse"
},
+ "parameterOrder": [
+ "encodedRequest"
+ ],
"parameters": {
"clientId": {
- "location": "query",
"description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"clientVersion": {
- "location": "query",
"description": "The version of the client implementation.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"encodedRequest": {
"format": "byte",
@@ -147,46 +52,103 @@
},
"flatPath": "v4/encodedUpdates/{encodedRequest}",
"path": "v4/encodedUpdates/{encodedRequest}",
- "id": "safebrowsing.encodedUpdates.get"
+ "id": "safebrowsing.encodedUpdates.get",
+ "description": ""
+ }
+ }
+ },
+ "threatListUpdates": {
+ "methods": {
+ "fetch": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "FetchThreatListUpdatesResponse"
+ },
+ "parameters": {},
+ "flatPath": "v4/threatListUpdates:fetch",
+ "path": "v4/threatListUpdates:fetch",
+ "id": "safebrowsing.threatListUpdates.fetch",
+ "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
+ "request": {
+ "$ref": "FetchThreatListUpdatesRequest"
+ }
+ }
+ }
+ },
+ "encodedFullHashes": {
+ "methods": {
+ "get": {
+ "description": "",
+ "response": {
+ "$ref": "FindFullHashesResponse"
+ },
+ "parameterOrder": [
+ "encodedRequest"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "clientId": {
+ "location": "query",
+ "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
+ "type": "string"
+ },
+ "clientVersion": {
+ "location": "query",
+ "description": "The version of the client implementation.",
+ "type": "string"
+ },
+ "encodedRequest": {
+ "location": "path",
+ "format": "byte",
+ "description": "A serialized FindFullHashesRequest proto.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v4/encodedFullHashes/{encodedRequest}",
+ "id": "safebrowsing.encodedFullHashes.get",
+ "path": "v4/encodedFullHashes/{encodedRequest}"
+ }
+ }
+ },
+ "threatLists": {
+ "methods": {
+ "list": {
+ "description": "Lists the Safe Browsing threat lists available for download.",
+ "response": {
+ "$ref": "ListThreatListsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {},
+ "flatPath": "v4/threatLists",
+ "id": "safebrowsing.threatLists.list",
+ "path": "v4/threatLists"
+ }
+ }
+ },
+ "threatMatches": {
+ "methods": {
+ "find": {
+ "description": "Finds the threat entries that match the Safe Browsing lists.",
+ "request": {
+ "$ref": "FindThreatMatchesRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "FindThreatMatchesResponse"
+ },
+ "parameters": {},
+ "flatPath": "v4/threatMatches:find",
+ "path": "v4/threatMatches:find",
+ "id": "safebrowsing.threatMatches.find"
}
}
}
},
"parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
"access_token": {
"description": "OAuth access token.",
"type": "string",
@@ -198,9 +160,9 @@
"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",
@@ -209,9 +171,9 @@
"type": "boolean"
},
"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.",
@@ -229,387 +191,57 @@
"default": "true",
"type": "boolean"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.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": {
+ "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."
}
},
"schemas": {
- "FetchThreatListUpdatesRequest": {
- "id": "FetchThreatListUpdatesRequest",
- "description": "Describes a Safe Browsing API update request. Clients can request updates for\nmultiple lists in a single request.\nNOTE: Field index 2 is unused.\nNEXT: 5",
- "type": "object",
- "properties": {
- "listUpdateRequests": {
- "description": "The requested threat list updates.",
- "items": {
- "$ref": "ListUpdateRequest"
- },
- "type": "array"
- },
- "client": {
- "$ref": "ClientInfo",
- "description": "The client metadata."
- }
- }
- },
- "ListUpdateResponse": {
- "id": "ListUpdateResponse",
- "description": "An update to an individual list.",
- "type": "object",
- "properties": {
- "checksum": {
- "$ref": "Checksum",
- "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
- },
- "responseType": {
- "enumDescriptions": [
- "Unknown.",
- "Partial updates are applied to the client's existing local database.",
- "Full updates replace the client's entire local database. This means\nthat either the client was seriously out-of-date or the client is\nbelieved to be corrupt."
- ],
- "enum": [
- "RESPONSE_TYPE_UNSPECIFIED",
- "PARTIAL_UPDATE",
- "FULL_UPDATE"
- ],
- "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
- "type": "string"
- },
- "threatType": {
- "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.",
- "Social engineering threat type for internal use.",
- "API abuse threat type.",
- "Malicious binary threat type.",
- "Client side detection whitelist threat type.",
- "Client side download detection whitelist threat type.",
- "Client incident threat type.",
- "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
- "List used for offline APK checks in PAM.",
- "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
- ],
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION",
- "SOCIAL_ENGINEERING_INTERNAL",
- "API_ABUSE",
- "MALICIOUS_BINARY",
- "CSD_WHITELIST",
- "CSD_DOWNLOAD_WHITELIST",
- "CLIENT_INCIDENT",
- "CLIENT_INCIDENT_WHITELIST",
- "APK_MALWARE_OFFLINE",
- "SUBRESOURCE_FILTER"
- ]
- },
- "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.",
- "items": {
- "$ref": "ThreatEntrySet"
- },
- "type": "array"
- },
- "newClientState": {
- "format": "byte",
- "description": "The new client state, in encrypted format. Opaque to clients.",
- "type": "string"
- },
- "platformType": {
- "description": "The platform type for which data is returned.",
- "type": "string",
- "enumDescriptions": [
- "Unknown platform.",
- "Threat posed to Windows.",
- "Threat posed to Linux.",
- "Threat posed to Android.",
- "Threat posed to OS X.",
- "Threat posed to iOS.",
- "Threat posed to at least one of the defined platforms.",
- "Threat posed to all defined platforms.",
- "Threat posed to Chrome."
- ],
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ]
- },
- "threatEntryType": {
- "description": "The format of the threats.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range.",
- "Chrome extension.",
- "Filename.",
- "CERT"
- ],
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE",
- "CHROME_EXTENSION",
- "FILENAME",
- "CERT"
- ]
- },
- "additions": {
- "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
- "items": {
- "$ref": "ThreatEntrySet"
- },
- "type": "array"
- }
- }
- },
- "Constraints": {
- "id": "Constraints",
- "description": "The constraints for this update.",
- "type": "object",
- "properties": {
- "region": {
- "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.",
- "type": "string"
- },
- "maxDatabaseEntries": {
- "format": "int32",
- "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 between 2**10 and\n2**20. If zero, no database size limit is set.",
- "type": "integer"
- },
- "supportedCompressions": {
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ],
- "description": "The compression types supported by the client.",
- "items": {
- "type": "string",
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ]
- },
- "type": "array"
- },
- "maxUpdateEntries": {
- "format": "int32",
- "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
- "type": "integer"
- }
- }
- },
- "ThreatMatch": {
- "id": "ThreatMatch",
- "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
- "type": "object",
- "properties": {
- "platformType": {
- "enumDescriptions": [
- "Unknown platform.",
- "Threat posed to Windows.",
- "Threat posed to Linux.",
- "Threat posed to Android.",
- "Threat posed to OS X.",
- "Threat posed to iOS.",
- "Threat posed to at least one of the defined platforms.",
- "Threat posed to all defined platforms.",
- "Threat posed to Chrome."
- ],
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ],
- "description": "The platform type matching this threat.",
- "type": "string"
- },
- "threatEntryType": {
- "description": "The threat entry type matching this threat.",
- "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"
- ]
- },
- "cacheDuration": {
- "format": "google-duration",
- "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.",
- "type": "string"
- },
- "threatType": {
- "description": "The threat type matching this threat.",
- "type": "string",
- "enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type.",
- "Social engineering threat type for internal use.",
- "API abuse threat type.",
- "Malicious binary threat type.",
- "Client side detection whitelist threat type.",
- "Client side download detection whitelist threat type.",
- "Client incident threat type.",
- "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
- "List used for offline APK checks in PAM.",
- "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
- ],
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION",
- "SOCIAL_ENGINEERING_INTERNAL",
- "API_ABUSE",
- "MALICIOUS_BINARY",
- "CSD_WHITELIST",
- "CSD_DOWNLOAD_WHITELIST",
- "CLIENT_INCIDENT",
- "CLIENT_INCIDENT_WHITELIST",
- "APK_MALWARE_OFFLINE",
- "SUBRESOURCE_FILTER"
- ]
- },
- "threatEntryMetadata": {
- "description": "Optional metadata associated with this threat.",
- "$ref": "ThreatEntryMetadata"
- },
- "threat": {
- "$ref": "ThreatEntry",
- "description": "The threat matching this threat."
- }
- }
- },
- "ListThreatListsResponse": {
- "type": "object",
- "properties": {
- "threatLists": {
- "description": "The lists available for download by the client.",
- "items": {
- "$ref": "ThreatListDescriptor"
- },
- "type": "array"
- }
- },
- "id": "ListThreatListsResponse"
- },
- "RiceDeltaEncoding": {
- "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
- "type": "object",
- "properties": {
- "encodedData": {
- "format": "byte",
- "description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
- "type": "string"
- },
- "firstValue": {
- "format": "int64",
- "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.",
- "type": "string"
- },
- "numEntries": {
- "format": "int32",
- "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero and the single value will be\nstored in `first_value`.",
- "type": "integer"
- },
- "riceParameter": {
- "format": "int32",
- "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.",
- "type": "integer"
- }
- },
- "id": "RiceDeltaEncoding"
- },
- "ThreatEntry": {
- "id": "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": {
- "format": "byte",
- "description": "The digest of an executable in SHA256 format. The API supports both\nbinary and hex digests. For JSON requests, digests are base64-encoded.",
- "type": "string"
- },
- "hash": {
- "format": "byte",
- "description": "A hash prefix, consisting of the most significant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON requests, hashes are\nbase64-encoded.",
- "type": "string"
- },
- "url": {
- "description": "A URL.",
- "type": "string"
- }
- }
- },
- "FindThreatMatchesResponse": {
- "type": "object",
- "properties": {
- "matches": {
- "description": "The threat list matches.",
- "items": {
- "$ref": "ThreatMatch"
- },
- "type": "array"
- }
- },
- "id": "FindThreatMatchesResponse"
- },
"ThreatListDescriptor": {
"description": "Describes an individual threat list. A list is defined by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.",
"type": "object",
"properties": {
"platformType": {
- "description": "The platform type targeted by the list's entries.",
- "type": "string",
"enumDescriptions": [
"Unknown platform.",
"Threat posed to Windows.",
@@ -631,7 +263,9 @@
"ANY_PLATFORM",
"ALL_PLATFORMS",
"CHROME"
- ]
+ ],
+ "description": "The platform type targeted by the list's entries.",
+ "type": "string"
},
"threatType": {
"description": "The threat type posed by the list's entries.",
@@ -695,21 +329,21 @@
"id": "ThreatListDescriptor"
},
"MetadataEntry": {
- "id": "MetadataEntry",
"description": "A single metadata entry.",
"type": "object",
"properties": {
- "value": {
- "format": "byte",
- "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
- "type": "string"
- },
"key": {
"format": "byte",
"description": "The metadata entry key. For JSON requests, the key is base64-encoded.",
"type": "string"
+ },
+ "value": {
+ "type": "string",
+ "format": "byte",
+ "description": "The metadata entry value. For JSON requests, the value is base64-encoded."
}
- }
+ },
+ "id": "MetadataEntry"
},
"ClientInfo": {
"id": "ClientInfo",
@@ -731,7 +365,84 @@
"description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
"type": "object",
"properties": {
+ "platformTypes": {
+ "description": "The platform types to be checked.",
+ "items": {
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ]
+ },
+ "threatEntries": {
+ "description": "The threat entries to be checked.",
+ "items": {
+ "$ref": "ThreatEntry"
+ },
+ "type": "array"
+ },
+ "threatEntryTypes": {
+ "description": "The entry types to be checked.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ]
+ },
+ "type": "array",
+ "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.",
+ "Social engineering threat type for internal use.",
+ "API abuse threat type.",
+ "Malicious binary threat type.",
+ "Client side detection whitelist threat type.",
+ "Client side download detection whitelist threat type.",
+ "Client incident threat type.",
+ "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
+ "List used for offline APK checks in PAM.",
+ "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
+ ],
"description": "The threat types to be checked.",
"items": {
"type": "string",
@@ -752,101 +463,24 @@
"SUBRESOURCE_FILTER"
]
},
- "type": "array",
- "enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type.",
- "Social engineering threat type for internal use.",
- "API abuse threat type.",
- "Malicious binary threat type.",
- "Client side detection whitelist threat type.",
- "Client side download detection whitelist threat type.",
- "Client incident threat type.",
- "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
- "List used for offline APK checks in PAM.",
- "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
- ]
- },
- "platformTypes": {
- "enumDescriptions": [
- "Unknown platform.",
- "Threat posed to Windows.",
- "Threat posed to Linux.",
- "Threat posed to Android.",
- "Threat posed to OS X.",
- "Threat posed to iOS.",
- "Threat posed to at least one of the defined platforms.",
- "Threat posed to all defined platforms.",
- "Threat posed to Chrome."
- ],
- "description": "The platform types to be checked.",
- "items": {
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "threatEntries": {
- "description": "The threat entries to be checked.",
- "items": {
- "$ref": "ThreatEntry"
- },
- "type": "array"
- },
- "threatEntryTypes": {
- "enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range.",
- "Chrome extension.",
- "Filename.",
- "CERT"
- ],
- "description": "The entry types to be checked.",
- "items": {
- "type": "string",
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE",
- "CHROME_EXTENSION",
- "FILENAME",
- "CERT"
- ]
- },
"type": "array"
}
}
},
"FindThreatMatchesRequest": {
- "id": "FindThreatMatchesRequest",
"description": "Request to check entries against lists.",
"type": "object",
"properties": {
"client": {
- "$ref": "ClientInfo",
- "description": "The client metadata."
+ "description": "The client metadata.",
+ "$ref": "ClientInfo"
},
"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"
},
"ThreatEntryMetadata": {
"description": "The metadata associated with a specific threat entry. The client is expected\nto know the metadata key/value pairs associated with each threat type.",
@@ -863,8 +497,6 @@
"id": "ThreatEntryMetadata"
},
"RawIndices": {
- "id": "RawIndices",
- "description": "A set of raw indices to remove from a local list.",
"type": "object",
"properties": {
"indices": {
@@ -875,7 +507,9 @@
},
"type": "array"
}
- }
+ },
+ "id": "RawIndices",
+ "description": "A set of raw indices to remove from a local list."
},
"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.",
@@ -895,7 +529,6 @@
"id": "RawHashes"
},
"FetchThreatListUpdatesResponse": {
- "id": "FetchThreatListUpdatesResponse",
"type": "object",
"properties": {
"minimumWaitDuration": {
@@ -910,12 +543,19 @@
},
"type": "array"
}
- }
+ },
+ "id": "FetchThreatListUpdatesResponse"
},
"FindFullHashesResponse": {
- "id": "FindFullHashesResponse",
"type": "object",
"properties": {
+ "matches": {
+ "description": "The full hashes that matched the requested prefixes.",
+ "items": {
+ "$ref": "ThreatMatch"
+ },
+ "type": "array"
+ },
"negativeCacheDuration": {
"format": "google-duration",
"description": "For requested entities that did not match the threat list, how long to\ncache the response.",
@@ -925,19 +565,11 @@
"format": "google-duration",
"description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.",
"type": "string"
- },
- "matches": {
- "description": "The full hashes that matched the requested prefixes.",
- "items": {
- "$ref": "ThreatMatch"
- },
- "type": "array"
}
- }
+ },
+ "id": "FindFullHashesResponse"
},
"Checksum": {
- "id": "Checksum",
- "description": "The expected state of a client's local database.",
"type": "object",
"properties": {
"sha256": {
@@ -945,34 +577,14 @@
"description": "The SHA256 hash of the client state; that is, of the sorted list of all\nhashes present in the database.",
"type": "string"
}
- }
+ },
+ "id": "Checksum",
+ "description": "The expected state of a client's local database."
},
"ThreatEntrySet": {
"description": "A set of threats that should be added or removed from a client's local\ndatabase.",
"type": "object",
"properties": {
- "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"
- },
- "compressionType": {
- "description": "The compression type for the entries in this set.",
- "type": "string",
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ],
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ]
- },
- "rawIndices": {
- "$ref": "RawIndices",
- "description": "The raw removal indices for a local list."
- },
"rawHashes": {
"$ref": "RawHashes",
"description": "The raw SHA256-formatted entries."
@@ -980,12 +592,33 @@
"riceHashes": {
"$ref": "RiceDeltaEncoding",
"description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data."
+ },
+ "riceIndices": {
+ "$ref": "RiceDeltaEncoding",
+ "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data."
+ },
+ "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."
+ ]
+ },
+ "rawIndices": {
+ "$ref": "RawIndices",
+ "description": "The raw removal indices for a local list."
}
},
"id": "ThreatEntrySet"
},
"FindFullHashesRequest": {
- "id": "FindFullHashesRequest",
"description": "Request to return full hashes matched by the provided hash prefixes.",
"type": "object",
"properties": {
@@ -1009,34 +642,12 @@
"$ref": "ThreatInfo",
"description": "The lists and hashes to be checked."
}
- }
+ },
+ "id": "FindFullHashesRequest"
},
"ListUpdateRequest": {
- "description": "A single list update request.",
"type": "object",
"properties": {
- "threatEntryType": {
- "enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range.",
- "Chrome extension.",
- "Filename.",
- "CERT"
- ],
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE",
- "CHROME_EXTENSION",
- "FILENAME",
- "CERT"
- ],
- "description": "The types of entries present in the list.",
- "type": "string"
- },
"state": {
"format": "byte",
"description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
@@ -1073,7 +684,164 @@
"description": "The constraints associated with this request."
},
"threatType": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type.",
+ "Social engineering threat type for internal use.",
+ "API abuse threat type.",
+ "Malicious binary threat type.",
+ "Client side detection whitelist threat type.",
+ "Client side download detection whitelist threat type.",
+ "Client incident threat type.",
+ "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
+ "List used for offline APK checks in PAM.",
+ "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION",
+ "SOCIAL_ENGINEERING_INTERNAL",
+ "API_ABUSE",
+ "MALICIOUS_BINARY",
+ "CSD_WHITELIST",
+ "CSD_DOWNLOAD_WHITELIST",
+ "CLIENT_INCIDENT",
+ "CLIENT_INCIDENT_WHITELIST",
+ "APK_MALWARE_OFFLINE",
+ "SUBRESOURCE_FILTER"
+ ],
"description": "The type of threat posed by entries present in the list.",
+ "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 types of entries present in the list.",
+ "type": "string"
+ }
+ },
+ "id": "ListUpdateRequest",
+ "description": "A single list update request."
+ },
+ "FetchThreatListUpdatesRequest": {
+ "type": "object",
+ "properties": {
+ "listUpdateRequests": {
+ "description": "The requested threat list updates.",
+ "items": {
+ "$ref": "ListUpdateRequest"
+ },
+ "type": "array"
+ },
+ "client": {
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
+ }
+ },
+ "id": "FetchThreatListUpdatesRequest",
+ "description": "Describes a Safe Browsing API update request. Clients can request updates for\nmultiple lists in a single request.\nNOTE: Field index 2 is unused.\nNEXT: 5"
+ },
+ "ListUpdateResponse": {
+ "description": "An update to an individual list.",
+ "type": "object",
+ "properties": {
+ "platformType": {
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ],
+ "description": "The platform type 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.",
+ "items": {
+ "$ref": "ThreatEntrySet"
+ },
+ "type": "array"
+ },
+ "checksum": {
+ "$ref": "Checksum",
+ "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
+ },
+ "responseType": {
+ "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."
+ ],
+ "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."
+ },
+ "threatType": {
+ "description": "The threat type for which data is returned.",
"type": "string",
"enumDescriptions": [
"Unknown.",
@@ -1107,24 +875,256 @@
"APK_MALWARE_OFFLINE",
"SUBRESOURCE_FILTER"
]
+ },
+ "newClientState": {
+ "type": "string",
+ "format": "byte",
+ "description": "The new client state, in encrypted format. Opaque to clients."
+ },
+ "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.",
+ "items": {
+ "$ref": "ThreatEntrySet"
+ },
+ "type": "array"
}
},
- "id": "ListUpdateRequest"
+ "id": "ListUpdateResponse"
+ },
+ "Constraints": {
+ "description": "The constraints for this update.",
+ "type": "object",
+ "properties": {
+ "maxUpdateEntries": {
+ "format": "int32",
+ "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
+ "type": "integer"
+ },
+ "region": {
+ "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.",
+ "type": "string"
+ },
+ "maxDatabaseEntries": {
+ "format": "int32",
+ "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 between 2**10 and\n2**20. If zero, no database size limit is set.",
+ "type": "integer"
+ },
+ "supportedCompressions": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Raw, uncompressed data.",
+ "Rice-Golomb encoded data."
+ ],
+ "description": "The compression types supported by the client.",
+ "items": {
+ "enum": [
+ "COMPRESSION_TYPE_UNSPECIFIED",
+ "RAW",
+ "RICE"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Constraints"
+ },
+ "ThreatMatch": {
+ "properties": {
+ "threatEntryType": {
+ "description": "The threat entry type matching this threat.",
+ "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"
+ ]
+ },
+ "cacheDuration": {
+ "format": "google-duration",
+ "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.",
+ "type": "string"
+ },
+ "threatType": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type.",
+ "Social engineering threat type for internal use.",
+ "API abuse threat type.",
+ "Malicious binary threat type.",
+ "Client side detection whitelist threat type.",
+ "Client side download detection whitelist threat type.",
+ "Client incident threat type.",
+ "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
+ "List used for offline APK checks in PAM.",
+ "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION",
+ "SOCIAL_ENGINEERING_INTERNAL",
+ "API_ABUSE",
+ "MALICIOUS_BINARY",
+ "CSD_WHITELIST",
+ "CSD_DOWNLOAD_WHITELIST",
+ "CLIENT_INCIDENT",
+ "CLIENT_INCIDENT_WHITELIST",
+ "APK_MALWARE_OFFLINE",
+ "SUBRESOURCE_FILTER"
+ ],
+ "description": "The threat type matching this threat.",
+ "type": "string"
+ },
+ "threatEntryMetadata": {
+ "$ref": "ThreatEntryMetadata",
+ "description": "Optional metadata associated with this threat."
+ },
+ "threat": {
+ "$ref": "ThreatEntry",
+ "description": "The threat matching this threat."
+ },
+ "platformType": {
+ "description": "The platform type matching this threat.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ]
+ }
+ },
+ "id": "ThreatMatch",
+ "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
+ "type": "object"
+ },
+ "ListThreatListsResponse": {
+ "type": "object",
+ "properties": {
+ "threatLists": {
+ "description": "The lists available for download by the client.",
+ "items": {
+ "$ref": "ThreatListDescriptor"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListThreatListsResponse"
+ },
+ "RiceDeltaEncoding": {
+ "type": "object",
+ "properties": {
+ "riceParameter": {
+ "format": "int32",
+ "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.",
+ "type": "integer"
+ },
+ "encodedData": {
+ "format": "byte",
+ "description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
+ "type": "string"
+ },
+ "firstValue": {
+ "format": "int64",
+ "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.",
+ "type": "string"
+ },
+ "numEntries": {
+ "format": "int32",
+ "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero and the single value will be\nstored in `first_value`.",
+ "type": "integer"
+ }
+ },
+ "id": "RiceDeltaEncoding",
+ "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices."
+ },
+ "FindThreatMatchesResponse": {
+ "properties": {
+ "matches": {
+ "description": "The threat list matches.",
+ "items": {
+ "$ref": "ThreatMatch"
+ },
+ "type": "array"
+ }
+ },
+ "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": {
+ "hash": {
+ "format": "byte",
+ "description": "A hash prefix, consisting of the most significant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON requests, hashes are\nbase64-encoded.",
+ "type": "string"
+ },
+ "url": {
+ "description": "A URL.",
+ "type": "string"
+ },
+ "digest": {
+ "format": "byte",
+ "description": "The digest of an executable in SHA256 format. The API supports both\nbinary and hex digests. For JSON requests, digests are base64-encoded.",
+ "type": "string"
+ }
+ },
+ "id": "ThreatEntry"
}
},
- "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": "v4",
"baseUrl": "https://safebrowsing.googleapis.com/",
"servicePath": "",
- "kind": "discovery#restDescription",
"description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources.",
+ "kind": "discovery#restDescription",
"rootUrl": "https://safebrowsing.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "safebrowsing",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "revision": "20170814",
+ "documentationLink": "https://developers.google.com/safe-browsing/",
+ "id": "safebrowsing:v4",
+ "title": "Google Safe Browsing API"
}
diff --git a/script/v1/script-api.json b/script/v1/script-api.json
index 35a09d5..a7c93cc 100644
--- a/script/v1/script-api.json
+++ b/script/v1/script-api.json
@@ -1,25 +1,31 @@
{
- "batchPath": "batch",
- "id": "script:v1",
- "revision": "20170818",
- "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
- "title": "Google Apps Script Execution API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"scripts": {
"methods": {
"run": {
+ "flatPath": "v1/scripts/{scriptId}:run",
+ "id": "script.scripts.run",
+ "path": "v1/scripts/{scriptId}:run",
+ "description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script Execution API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.",
"request": {
"$ref": "ExecutionRequest"
},
- "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.",
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"scriptId"
],
- "response": {
- "$ref": "Operation"
+ "httpMethod": "POST",
+ "parameters": {
+ "scriptId": {
+ "location": "path",
+ "description": "The script ID of the script to be executed. To find the script ID, open\nthe project in the script editor and select **File \u003e Project properties**.",
+ "type": "string",
+ "required": true
+ }
},
"scopes": [
"https://mail.google.com/",
@@ -33,18 +39,7 @@
"https://www.googleapis.com/auth/groups",
"https://www.googleapis.com/auth/spreadsheets",
"https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "scriptId": {
- "location": "path",
- "description": "The script ID of the script to be executed. To find the script ID, open\nthe project in the script editor and select **File \u003e Project properties**.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/scripts/{scriptId}:run",
- "path": "v1/scripts/{scriptId}:run",
- "id": "script.scripts.run"
+ ]
}
}
}
@@ -56,9 +51,9 @@
"type": "string"
},
"oauth_token": {
+ "type": "string",
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "description": "OAuth 2.0 token for the current user."
},
"upload_protocol": {
"location": "query",
@@ -66,22 +61,23 @@
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "boolean",
+ "location": "query"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"$.xgafv": {
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -91,8 +87,7 @@
"1",
"2"
],
- "description": "V1 error format.",
- "type": "string"
+ "description": "V1 error format."
},
"callback": {
"location": "query",
@@ -116,14 +111,14 @@
]
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"location": "query",
@@ -138,6 +133,59 @@
}
},
"schemas": {
+ "Status": {
+ "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [`google.rpc.Status.details`](google.rpc.Status.details) field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error.",
+ "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. For this API, this value will always be 3, corresponding to an \u003ccode\u003eINVALID_ARGUMENT\u003c/code\u003e error.",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
+ "ExecutionRequest": {
+ "type": "object",
+ "properties": {
+ "devMode": {
+ "description": "If `true` and the user is an owner of the script, the script runs at the\nmost recently saved version rather than the version deployed for use with\nthe Execution API. Optional; default is `false`.",
+ "type": "boolean"
+ },
+ "function": {
+ "description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
+ "type": "string"
+ },
+ "parameters": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array",
+ "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected type in Apps Script.\nParameters cannot be Apps Script-specific object types (such as a\n`Document` or a `Calendar`); they can only be primitive types such as\n`string`, `number`, `array`, `object`, or `boolean`. Optional."
+ },
+ "sessionState": {
+ "description": "For Android add-ons only. An ID that represents the user's current session\nin the Android app for Google Docs or Sheets, included as extra data in the\n[`Intent`](https://developer.android.com/guide/components/intents-filters.html)\nthat launches the add-on. When an Android add-on is run with a session\nstate, it gains the privileges of a\n[bound](https://developers.google.com/apps-script/guides/bound) script —\nthat is, it can access information like the user's current cursor position\n(in Docs) or selected cell (in Sheets). To retrieve the state, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional.",
+ "type": "string"
+ }
+ },
+ "id": "ExecutionRequest",
+ "description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script."
+ },
"ExecutionResponse": {
"description": "An object that provides the return value of a function executed through the\nApps Script Execution API. If a\n`run` call succeeds and the\nscript function returns successfully, the response body's\n`response` field contains this\n`ExecutionResponse` object.",
"type": "object",
@@ -153,18 +201,6 @@
"description": "The response will not arrive until the function finishes executing. The maximum runtime is listed in the guide to [limitations in Apps Script](https://developers.google.com/apps-script/guides/services/quotas#current_limitations).\n\u003cp\u003eIf the script function returns successfully, the `response` field will contain an `ExecutionResponse` object with the function's return value in the object's `result` field.\u003c/p\u003e\n\u003cp\u003eIf the script function (or Apps Script itself) throws an exception, the `error` field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.\u003c/p\u003e\n\u003cp\u003eIf the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.\u003c/p\u003e",
"type": "object",
"properties": {
- "done": {
- "description": "This field is only used with asynchronous executions and indicates whether or not the script execution has completed. A completed execution has a populated response field containing the `ExecutionResponse` from function that was executed.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.",
- "type": "object"
- },
"name": {
"description": "This field is only used with asynchronous executions and contains a unique identifier that can be used to subsequently invoke a `get` `cancel` or `join` on the asynchronous script execution identified by this name.",
"type": "string"
@@ -174,106 +210,65 @@
"description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error."
},
"metadata": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "This field is not used."
+ "description": "This field is not used.",
+ "type": "object"
+ },
+ "done": {
+ "description": "This field is only used with asynchronous executions and indicates whether or not the script execution has completed. A completed execution has a populated response field containing the `ExecutionResponse` from function that was executed.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.",
+ "type": "object"
}
},
"id": "Operation"
},
"ScriptStackTraceElement": {
- "description": "A stack trace through the script that shows where the execution failed.",
- "type": "object",
"properties": {
- "function": {
- "type": "string",
- "description": "The name of the function that failed."
- },
"lineNumber": {
- "type": "integer",
"format": "int32",
- "description": "The line number where the script failed."
+ "description": "The line number where the script failed.",
+ "type": "integer"
+ },
+ "function": {
+ "description": "The name of the function that failed.",
+ "type": "string"
}
},
- "id": "ScriptStackTraceElement"
+ "id": "ScriptStackTraceElement",
+ "description": "A stack trace through the script that shows where the execution failed.",
+ "type": "object"
},
"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": {
- "items": {
- "$ref": "ScriptStackTraceElement"
- },
- "type": "array",
- "description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first."
- },
"errorType": {
- "type": "string",
- "description": "The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included."
+ "description": "The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included.",
+ "type": "string"
},
"errorMessage": {
"description": "The error message thrown by Apps Script, usually localized into the user's\nlanguage.",
"type": "string"
+ },
+ "scriptStackTraceElements": {
+ "description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first.",
+ "items": {
+ "$ref": "ScriptStackTraceElement"
+ },
+ "type": "array"
}
},
"id": "ExecutionError"
- },
- "Status": {
- "properties": {
- "code": {
- "format": "int32",
- "description": "The status code. For this API, this value will always be 3, corresponding to an \u003ccode\u003eINVALID_ARGUMENT\u003c/code\u003e error.",
- "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"
- },
- "details": {
- "description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- }
- },
- "id": "Status",
- "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.",
- "type": "object"
- },
- "ExecutionRequest": {
- "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"
- },
- "devMode": {
- "description": "If `true` and the user is an owner of the script, the script runs at the\nmost recently saved version rather than the version deployed for use with\nthe Execution API. Optional; default is `false`.",
- "type": "boolean"
- },
- "function": {
- "type": "string",
- "description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters."
- },
- "parameters": {
- "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected type in Apps Script.\nParameters cannot be Apps Script-specific object types (such as a\n`Document` or a `Calendar`); they can only be primitive types such as\n`string`, `number`, `array`, `object`, or `boolean`. Optional.",
- "items": {
- "type": "any"
- },
- "type": "array"
- }
- },
- "id": "ExecutionRequest",
- "description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script."
}
},
"icons": {
@@ -286,23 +281,17 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/groups": {
- "description": "View and manage your Google Groups"
- },
- "https://www.googleapis.com/auth/forms.currentonly": {
- "description": "View and manage forms that this application has been installed in"
- },
"https://www.googleapis.com/auth/drive": {
"description": "View and manage the files in your Google Drive"
},
- "https://www.googleapis.com/auth/admin.directory.group": {
- "description": "View and manage the provisioning of groups on your domain"
+ "https://www.googleapis.com/auth/spreadsheets": {
+ "description": "View and manage your spreadsheets in Google Drive"
},
"https://mail.google.com/": {
"description": "Read, send, delete, and manage your email"
},
- "https://www.googleapis.com/auth/spreadsheets": {
- "description": "View and manage your spreadsheets in Google Drive"
+ "https://www.googleapis.com/auth/admin.directory.group": {
+ "description": "View and manage the provisioning of groups on your domain"
},
"https://www.googleapis.com/auth/admin.directory.user": {
"description": "View and manage the provisioning of users on your domain"
@@ -318,6 +307,12 @@
},
"https://www.google.com/calendar/feeds": {
"description": "Manage your calendars"
+ },
+ "https://www.googleapis.com/auth/groups": {
+ "description": "View and manage your Google Groups"
+ },
+ "https://www.googleapis.com/auth/forms.currentonly": {
+ "description": "View and manage forms that this application has been installed in"
}
}
}
@@ -328,5 +323,10 @@
"rootUrl": "https://script.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
- "name": "script"
+ "name": "script",
+ "batchPath": "batch",
+ "id": "script:v1",
+ "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
+ "revision": "20170823",
+ "title": "Google Apps Script Execution API"
}
diff --git a/searchconsole/v1/searchconsole-api.json b/searchconsole/v1/searchconsole-api.json
index b8fad93..13b1b93 100644
--- a/searchconsole/v1/searchconsole-api.json
+++ b/searchconsole/v1/searchconsole-api.json
@@ -1,20 +1,13 @@
{
- "baseUrl": "https://searchconsole.googleapis.com/",
- "canonicalName": "Search Console",
- "kind": "discovery#restDescription",
- "description": "Provides tools for running validation tests against single URLs",
- "servicePath": "",
- "rootUrl": "https://searchconsole.googleapis.com/",
- "basePath": "",
"ownerDomain": "google.com",
"name": "searchconsole",
"batchPath": "batch",
- "id": "searchconsole:v1",
+ "revision": "20170823",
"documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/",
- "revision": "20170819",
+ "id": "searchconsole:v1",
"title": "Google Search Console URL Testing Tools API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"urlTestingTools": {
@@ -22,6 +15,10 @@
"mobileFriendlyTest": {
"methods": {
"run": {
+ "description": "Runs Mobile-Friendly Test for a given URL.",
+ "request": {
+ "$ref": "RunMobileFriendlyTestRequest"
+ },
"response": {
"$ref": "RunMobileFriendlyTestResponse"
},
@@ -29,12 +26,8 @@
"httpMethod": "POST",
"parameters": {},
"flatPath": "v1/urlTestingTools/mobileFriendlyTest:run",
- "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run",
"path": "v1/urlTestingTools/mobileFriendlyTest:run",
- "description": "Runs Mobile-Friendly Test for a given URL.",
- "request": {
- "$ref": "RunMobileFriendlyTestRequest"
- }
+ "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run"
}
}
}
@@ -48,30 +41,35 @@
"location": "query"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
- "default": "true",
"type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "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"
},
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
- "default": "true",
"type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
"location": "query"
},
"uploadType": {
@@ -79,15 +77,10 @@
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enumDescriptions": [
@@ -119,9 +112,9 @@
"type": "string"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
@@ -130,6 +123,55 @@
}
},
"schemas": {
+ "ResourceIssue": {
+ "description": "Information about a resource with issue.",
+ "type": "object",
+ "properties": {
+ "blockedResource": {
+ "$ref": "BlockedResource",
+ "description": "Describes a blocked resource issue."
+ }
+ },
+ "id": "ResourceIssue"
+ },
+ "BlockedResource": {
+ "properties": {
+ "url": {
+ "description": "URL of the blocked resource.",
+ "type": "string"
+ }
+ },
+ "id": "BlockedResource",
+ "description": "Blocked resource.",
+ "type": "object"
+ },
+ "TestStatus": {
+ "description": "Final state of the test, including error details if necessary.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "Error details if applicable.",
+ "type": "string"
+ },
+ "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"
+ ]
+ }
+ },
+ "id": "TestStatus"
+ },
"RunMobileFriendlyTestRequest": {
"description": "Mobile-friendly test request.",
"type": "object",
@@ -154,20 +196,16 @@
"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.",
+ "format": "byte",
"type": "string"
}
},
"id": "Image"
},
"MobileFriendlyIssue": {
- "description": "Mobile-friendly issue.",
- "type": "object",
"properties": {
"rule": {
- "description": "Rule violated.",
- "type": "string",
"enumDescriptions": [
"Unknown rule. Sorry, we don't have any description for the rule that was\nbroken.",
"Plugins incompatible with mobile devices are being used. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usage).",
@@ -185,29 +223,20 @@
"SIZE_CONTENT_TO_VIEWPORT",
"USE_LEGIBLE_FONT_SIZES",
"TAP_TARGETS_TOO_CLOSE"
- ]
+ ],
+ "description": "Rule violated.",
+ "type": "string"
}
},
- "id": "MobileFriendlyIssue"
+ "id": "MobileFriendlyIssue",
+ "description": "Mobile-friendly issue.",
+ "type": "object"
},
"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": {
- "description": "Final state of the test, can be either complete or an error.",
- "$ref": "TestStatus"
- },
"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.",
@@ -217,70 +246,34 @@
"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": {
"$ref": "Image",
"description": "Screenshot of the requested URL."
+ },
+ "testStatus": {
+ "$ref": "TestStatus",
+ "description": "Final state of the test, can be either complete or an error."
+ },
+ "resourceIssues": {
+ "description": "Information about embedded resources issues.",
+ "type": "array",
+ "items": {
+ "$ref": "ResourceIssue"
+ }
}
},
"id": "RunMobileFriendlyTestResponse"
- },
- "ResourceIssue": {
- "description": "Information about a resource with issue.",
- "type": "object",
- "properties": {
- "blockedResource": {
- "$ref": "BlockedResource",
- "description": "Describes a blocked resource issue."
- }
- },
- "id": "ResourceIssue"
- },
- "BlockedResource": {
- "description": "Blocked resource.",
- "type": "object",
- "properties": {
- "url": {
- "description": "URL of the blocked resource.",
- "type": "string"
- }
- },
- "id": "BlockedResource"
- },
- "TestStatus": {
- "description": "Final state of the test, including error details if necessary.",
- "type": "object",
- "properties": {
- "status": {
- "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"
}
},
"protocol": "rest",
@@ -288,5 +281,12 @@
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "version": "v1"
+ "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": ""
}
diff --git a/servicecontrol/v1/servicecontrol-api.json b/servicecontrol/v1/servicecontrol-api.json
index 75acb7a..601c5eb 100644
--- a/servicecontrol/v1/servicecontrol-api.json
+++ b/servicecontrol/v1/servicecontrol-api.json
@@ -1,55 +1,20 @@
{
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Service Control API",
"ownerName": "Google",
"resources": {
"services": {
"methods": {
- "startReconciliation": {
- "flatPath": "v1/services/{serviceName}:startReconciliation",
- "path": "v1/services/{serviceName}:startReconciliation",
- "id": "servicecontrol.services.startReconciliation",
- "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
- "request": {
- "$ref": "StartReconciliationRequest"
- },
- "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.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ]
- },
"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"
},
- "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).",
- "response": {
- "$ref": "CheckResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"serviceName"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
+ "response": {
+ "$ref": "CheckResponse"
+ },
"parameters": {
"serviceName": {
"location": "path",
@@ -58,11 +23,26 @@
"required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
"flatPath": "v1/services/{serviceName}:check",
- "id": "servicecontrol.services.check",
- "path": "v1/services/{serviceName}:check"
+ "path": "v1/services/{serviceName}:check",
+ "id": "servicecontrol.services.check"
},
"releaseQuota": {
+ "request": {
+ "$ref": "ReleaseQuotaRequest"
+ },
+ "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).\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": "ReleaseQuotaResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/servicecontrol"
@@ -77,48 +57,39 @@
},
"flatPath": "v1/services/{serviceName}:releaseQuota",
"id": "servicecontrol.services.releaseQuota",
- "path": "v1/services/{serviceName}:releaseQuota",
- "request": {
- "$ref": "ReleaseQuotaRequest"
- },
- "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).\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": "ReleaseQuotaResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST"
+ "path": "v1/services/{serviceName}:releaseQuota"
},
"endReconciliation": {
- "description": "Signals the quota controller that service ends the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
- "request": {
- "$ref": "EndReconciliationRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
"response": {
"$ref": "EndReconciliationResponse"
},
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "type": "string",
- "required": true
- }
- },
+ "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.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"flatPath": "v1/services/{serviceName}:endReconciliation",
+ "id": "servicecontrol.services.endReconciliation",
"path": "v1/services/{serviceName}:endReconciliation",
- "id": "servicecontrol.services.endReconciliation"
+ "request": {
+ "$ref": "EndReconciliationRequest"
+ },
+ "description": "Signals the quota controller that service ends the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam)."
},
"report": {
+ "id": "servicecontrol.services.report",
+ "path": "v1/services/{serviceName}:report",
"description": "Reports operation results to Google Service Control, such as logs and\nmetrics. It should be called after an operation is completed.\n\nIf feasible, the client should aggregate reporting data for up to 5\nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce data loss during client crashes. Clients should carefully choose\nthe aggregation time window to avoid data loss risk more than 0.01%\nfor business and compliance reasons.\n\nNOTE: the ReportRequest has the size limit of 1MB.\n\nThis method requires the `servicemanagement.services.report` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
"request": {
"$ref": "ReportRequest"
@@ -132,8 +103,58 @@
"httpMethod": "POST",
"parameters": {
"serviceName": {
+ "location": "path",
"description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.",
"type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:report"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "AllocateQuotaResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:allocateQuota"
+ },
+ "startReconciliation": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "StartReconciliationResponse"
+ },
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "type": "string",
"required": true,
"location": "path"
}
@@ -142,42 +163,93 @@
"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": {
- "response": {
- "$ref": "AllocateQuotaResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:allocateQuota",
- "id": "servicecontrol.services.allocateQuota",
- "path": "v1/services/{serviceName}:allocateQuota",
- "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[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.",
+ "flatPath": "v1/services/{serviceName}:startReconciliation",
+ "path": "v1/services/{serviceName}:startReconciliation",
+ "id": "servicecontrol.services.startReconciliation",
+ "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
"request": {
- "$ref": "AllocateQuotaRequest"
+ "$ref": "StartReconciliationRequest"
}
}
}
}
},
"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": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -188,126 +260,511 @@
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
}
},
"version": "v1",
"baseUrl": "https://servicecontrol.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
"servicePath": "",
+ "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "servicecontrol:v1",
"documentationLink": "https://cloud.google.com/service-control/",
"revision": "20170819",
+ "id": "servicecontrol:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Money": {
- "description": "Represents an amount of money with its currency type.",
+ "CheckRequest": {
+ "properties": {
+ "skipActivationCheck": {
+ "description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.",
+ "type": "boolean"
+ },
+ "requestProjectSettings": {
+ "description": "Requests the project settings to be returned as part of the check response.",
+ "type": "boolean"
+ },
+ "operation": {
+ "description": "The operation to be checked.",
+ "$ref": "Operation"
+ },
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.",
+ "type": "string"
+ }
+ },
+ "id": "CheckRequest",
+ "description": "Request message for the Check method.",
+ "type": "object"
+ },
+ "QuotaOperation": {
+ "description": "Represents information regarding a quota operation.",
"type": "object",
"properties": {
- "units": {
- "format": "int64",
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "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"
},
- "currencyCode": {
- "description": "The 3-letter currency code defined in ISO 4217.",
+ "operationId": {
+ "description": "Identity of the operation. This is expected to be unique within the scope\nof the service that generated the operation, and guarantees idempotency in\ncase of retries.\n\nUUID version 4 is recommended, though not required. In scenarios where an\noperation is computed from existing information and an idempotent id is\ndesirable for deduplication purpose, UUID version 5 is recommended. See\nRFC 4122 for details.",
"type": "string"
},
- "nanos": {
+ "quotaMode": {
+ "enum": [
+ "UNSPECIFIED",
+ "NORMAL",
+ "BEST_EFFORT",
+ "CHECK_ONLY"
+ ],
+ "description": "Quota mode for this operation.",
+ "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",
+ "type": "string"
+ },
+ "quotaMetrics": {
+ "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.",
+ "items": {
+ "$ref": "MetricValueSet"
+ },
+ "type": "array"
+ }
+ },
+ "id": "QuotaOperation"
+ },
+ "EndReconciliationRequest": {
+ "type": "object",
+ "properties": {
+ "reconciliationOperation": {
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota reconciliation."
+ },
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
+ "type": "string"
+ }
+ },
+ "id": "EndReconciliationRequest"
+ },
+ "ReportInfo": {
+ "properties": {
+ "operationId": {
+ "description": "The Operation.operation_id value from the request.",
+ "type": "string"
+ },
+ "quotaInfo": {
+ "description": "Quota usage info when processing the `Operation`.",
+ "$ref": "QuotaInfo"
+ }
+ },
+ "id": "ReportInfo",
+ "type": "object"
+ },
+ "ReportResponse": {
+ "properties": {
+ "reportInfos": {
+ "description": "Quota usage for each quota release `Operation` request.\n\nFully or partially failed quota release request may or may not be present\nin `report_quota_info`. For example, a failed quota release request will\nhave the current quota usage info when precise quota library returns the\ninfo. A deadline exceeded quota request will not have quota usage info.\n\nIf there is no quota release request, report_quota_info will be empty.\n",
+ "items": {
+ "$ref": "ReportInfo"
+ },
+ "type": "array"
+ },
+ "serviceConfigId": {
+ "description": "The actual config id used to process the request.",
+ "type": "string"
+ },
+ "reportErrors": {
+ "description": "Partial failures, one for each `Operation` in the request that failed\nprocessing. There are three possible combinations of the RPC status:\n\n1. The combination of a successful RPC status and an empty `report_errors`\n list indicates a complete success where all `Operations` in the\n request are processed successfully.\n2. The combination of a successful RPC status and a non-empty\n `report_errors` list indicates a partial success where some\n `Operations` in the request succeeded. Each\n `Operation` that failed processing has a corresponding item\n in this list.\n3. A failed RPC status indicates a general non-deterministic failure.\n When this happens, it's impossible to know which of the\n 'Operations' in the request succeeded or failed.",
+ "items": {
+ "$ref": "ReportError"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ReportResponse",
+ "description": "Response message for the Report method.",
+ "type": "object"
+ },
+ "Operation": {
+ "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.",
+ "items": {
+ "$ref": "LogEntry"
+ },
+ "type": "array"
+ },
+ "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.",
+ "items": {
+ "$ref": "MetricValueSet"
+ },
+ "type": "array"
+ },
+ "quotaProperties": {
+ "$ref": "QuotaProperties",
+ "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request."
+ },
+ "consumerId": {
+ "description": "Identity of the consumer who is using the service.\nThis field should be filled in for the operations initiated by a\nconsumer, but not for service-initiated operations that are\nnot related to a specific consumer.\n\nThis can be in one of the following formats:\n project:\u003cproject_id\u003e,\n project_number:\u003cproject_number\u003e,\n api_key:\u003capi_key\u003e.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls\nCheck() and Report() on the same operation, the two calls should carry\nthe same id.\n\nUUID version 4 is recommended, though not required.\nIn scenarios where an operation is computed from existing information\nand an idempotent id is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC 4122 for details.",
+ "type": "string"
+ },
+ "operationName": {
+ "description": "Fully qualified name of the operation. Reserved for future use.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Required. Start time of the operation.",
+ "type": "string"
+ },
+ "resourceContainers": {
+ "description": "DO NOT USE.\nThis field is not ready for use yet.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "importance": {
+ "enum": [
+ "LOW",
+ "HIGH",
+ "DEBUG"
+ ],
+ "description": "DO NOT USE. This is an experimental field.",
+ "type": "string",
+ "enumDescriptions": [
+ "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
+ "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
+ "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
+ ]
+ },
+ "resourceContainer": {
+ "description": "The resource name of the parent of a resource in the resource hierarchy.\n\nThis can be in one of the following formats:\n - “projects/\u003cproject-id or project-number\u003e”\n - “folders/\u003cfolder-id\u003e”\n - “organizations/\u003corganization-id\u003e”",
+ "type": "string"
+ }
+ },
+ "id": "Operation",
+ "description": "Represents information regarding an operation.",
+ "type": "object"
+ },
+ "CheckResponse": {
+ "description": "Response message for the Check method.",
+ "type": "object",
+ "properties": {
+ "checkInfo": {
+ "description": "Feedback data returned from the server during processing a Check request.",
+ "$ref": "CheckInfo"
+ },
+ "checkErrors": {
+ "description": "Indicate the decision of the check.\n\nIf no check errors are present, the service should process the operation.\nOtherwise the service should use the list of errors to determine the\nappropriate action.",
+ "items": {
+ "$ref": "CheckError"
+ },
+ "type": "array"
+ },
+ "operationId": {
+ "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.",
+ "type": "string"
+ },
+ "serviceConfigId": {
+ "description": "The actual config id used to process the request.",
+ "type": "string"
+ },
+ "quotaInfo": {
+ "description": "Quota information for the check request associated with this response.\n",
+ "$ref": "QuotaInfo"
+ }
+ },
+ "id": "CheckResponse"
+ },
+ "ReportRequest": {
+ "properties": {
+ "serviceConfigId": {
+ "description": "Specifies which version of service config should be used to process the\nrequest.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "Operations to be reported.\n\nTypically the service should report one operation per request.\nPutting multiple operations into a single request is allowed, but should\nbe used only when multiple operations are natually available at the time\nof the report.\n\nIf multiple operations are in a single request, the total request size\nshould be no larger than 1MB. See ReportResponse.report_errors for\npartial failure behavior.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ReportRequest",
+ "description": "Request message for the Report method.",
+ "type": "object"
+ },
+ "Status": {
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
"format": "int32",
- "description": "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.",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
}
},
- "id": "Money"
+ "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"
},
- "EndReconciliationResponse": {
- "id": "EndReconciliationResponse",
+ "LogEntry": {
+ "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 that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.",
+ "type": "object"
+ },
+ "timestamp": {
+ "format": "google-datetime",
+ "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
+ "type": "object"
+ },
+ "severity": {
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ],
+ "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.",
+ "type": "string",
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ]
+ },
+ "insertId": {
+ "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
+ "type": "string"
+ },
+ "structPayload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.",
+ "type": "object"
+ },
+ "textPayload": {
+ "description": "The log entry payload, represented as a Unicode string (UTF-8).",
+ "type": "string"
+ }
+ },
+ "id": "LogEntry",
+ "description": "An individual log entry.",
+ "type": "object"
+ },
+ "AuditLog": {
+ "properties": {
+ "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"
+ },
+ "authorizationInfo": {
+ "description": "Authorization information. If there are multiple\nresources or permissions involved, then there is\none AuthorizationInfo element for each {resource, permission} tuple.",
+ "items": {
+ "$ref": "AuthorizationInfo"
+ },
+ "type": "array"
+ },
+ "resourceName": {
+ "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"",
+ "type": "string"
+ },
+ "request": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
+ "type": "object"
+ },
+ "serviceData": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Other service-specific data about the request, response, and other\nactivities.",
+ "type": "object"
+ },
+ "requestMetadata": {
+ "description": "Metadata about the operation.",
+ "$ref": "RequestMetadata"
+ },
+ "numResponseItems": {
+ "format": "int64",
+ "description": "The number of items returned from a List or Query API method,\nif applicable.",
+ "type": "string"
+ },
+ "authenticationInfo": {
+ "$ref": "AuthenticationInfo",
+ "description": "Authentication information."
+ },
+ "status": {
+ "description": "The status of the overall operation.",
+ "$ref": "Status"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
+ "type": "object"
+ },
+ "serviceName": {
+ "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
+ "type": "string"
+ }
+ },
+ "id": "AuditLog",
+ "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
+ "type": "object"
+ },
+ "MetricValue": {
+ "description": "Represents a single metric value.",
"type": "object",
"properties": {
+ "stringValue": {
+ "description": "A text string value.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.",
+ "type": "object"
+ },
+ "doubleValue": {
+ "format": "double",
+ "description": "A double precision floating point value.",
+ "type": "number"
+ },
+ "int64Value": {
+ "format": "int64",
+ "description": "A signed 64-bit integer value.",
+ "type": "string"
+ },
+ "distributionValue": {
+ "description": "A distribution value.",
+ "$ref": "Distribution"
+ },
+ "boolValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The end of the time period over which this metric value's measurement\napplies.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
+ "type": "string"
+ },
+ "moneyValue": {
+ "description": "A money value.",
+ "$ref": "Money"
+ }
+ },
+ "id": "MetricValue"
+ },
+ "EndReconciliationResponse": {
+ "properties": {
+ "quotaMetrics": {
+ "description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
+ "items": {
+ "$ref": "MetricValueSet"
+ },
+ "type": "array"
+ },
"reconciliationErrors": {
+ "description": "Indicates the decision of the reconciliation end.",
"items": {
"$ref": "QuotaError"
},
- "type": "array",
- "description": "Indicates the decision of the reconciliation end."
+ "type": "array"
},
"operationId": {
"description": "The same operation_id value used in the EndReconciliationRequest. Used for\nlogging and diagnostics purposes.",
@@ -316,41 +773,39 @@
"serviceConfigId": {
"description": "ID of the actual config used to process the request.",
"type": "string"
- },
- "quotaMetrics": {
- "description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
- "items": {
- "$ref": "MetricValueSet"
- },
- "type": "array"
}
- }
+ },
+ "id": "EndReconciliationResponse",
+ "type": "object"
+ },
+ "Money": {
+ "description": "Represents an amount of money with its currency type.",
+ "type": "object",
+ "properties": {
+ "currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string"
+ },
+ "nanos": {
+ "format": "int32",
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "type": "integer"
+ },
+ "units": {
+ "format": "int64",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "type": "string"
+ }
+ },
+ "id": "Money"
},
"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": {
- "mean": {
- "format": "double",
- "description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.",
- "type": "number"
- },
- "count": {
- "format": "int64",
- "description": "The total number of samples in the distribution. Must be \u003e= 0.",
- "type": "string"
- },
- "bucketCounts": {
- "description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
"explicitBuckets": {
- "description": "Buckets with arbitrary user-provided width.",
- "$ref": "ExplicitBuckets"
+ "$ref": "ExplicitBuckets",
+ "description": "Buckets with arbitrary user-provided width."
},
"maximum": {
"format": "double",
@@ -363,8 +818,8 @@
"type": "number"
},
"exponentialBuckets": {
- "$ref": "ExponentialBuckets",
- "description": "Buckets with exponentially growing width."
+ "description": "Buckets with exponentially growing width.",
+ "$ref": "ExponentialBuckets"
},
"minimum": {
"format": "double",
@@ -374,6 +829,24 @@
"linearBuckets": {
"description": "Buckets with constant width.",
"$ref": "LinearBuckets"
+ },
+ "count": {
+ "format": "int64",
+ "description": "The total number of samples in the distribution. Must be \u003e= 0.",
+ "type": "string"
+ },
+ "mean": {
+ "format": "double",
+ "description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.",
+ "type": "number"
+ },
+ "bucketCounts": {
+ "description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
}
},
"id": "Distribution"
@@ -394,15 +867,7 @@
"id": "ExplicitBuckets"
},
"ExponentialBuckets": {
- "id": "ExponentialBuckets",
- "description": "Describing buckets with exponentially growing width.",
- "type": "object",
"properties": {
- "numFiniteBuckets": {
- "format": "int32",
- "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
- "type": "integer"
- },
"growthFactor": {
"format": "double",
"description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.",
@@ -412,13 +877,18 @@
"format": "double",
"description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be \u003e 0.",
"type": "number"
+ },
+ "numFiniteBuckets": {
+ "format": "int32",
+ "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
+ "type": "integer"
}
- }
+ },
+ "id": "ExponentialBuckets",
+ "description": "Describing buckets with exponentially growing width.",
+ "type": "object"
},
"AuthorizationInfo": {
- "id": "AuthorizationInfo",
- "description": "Authorization information for the operation.",
- "type": "object",
"properties": {
"resource": {
"description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID",
@@ -429,18 +899,17 @@
"type": "boolean"
},
"permission": {
- "type": "string",
- "description": "The required IAM permission."
+ "description": "The required IAM permission.",
+ "type": "string"
}
- }
+ },
+ "id": "AuthorizationInfo",
+ "description": "Authorization information for the operation.",
+ "type": "object"
},
"StartReconciliationResponse": {
"type": "object",
"properties": {
- "serviceConfigId": {
- "description": "ID of the actual config used to process the request.",
- "type": "string"
- },
"quotaMetrics": {
"description": "Metric values as tracked by One Platform before the 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\"",
"items": {
@@ -458,6 +927,10 @@
"operationId": {
"description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes.",
"type": "string"
+ },
+ "serviceConfigId": {
+ "description": "ID of the actual config used to process the request.",
+ "type": "string"
}
},
"id": "StartReconciliationResponse"
@@ -466,6 +939,13 @@
"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.",
@@ -481,13 +961,6 @@
],
"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"
@@ -496,11 +969,6 @@
"description": "Describing buckets with constant width.",
"type": "object",
"properties": {
- "numFiniteBuckets": {
- "format": "int32",
- "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
- "type": "integer"
- },
"width": {
"format": "double",
"description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.\nMust be strictly positive.",
@@ -510,35 +978,32 @@
"format": "double",
"description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.",
"type": "number"
+ },
+ "numFiniteBuckets": {
+ "format": "int32",
+ "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
+ "type": "integer"
}
},
"id": "LinearBuckets"
},
"AuthenticationInfo": {
+ "description": "Authentication information for the operation.",
+ "type": "object",
"properties": {
- "principalEmail": {
- "description": "The email address of the authenticated user making the request.\nFor privacy reasons, the principal email address is redacted for all\nread-only operations that fail with a \"permission denied\" error.",
- "type": "string"
- },
"authoritySelector": {
"description": "The authority selector specified by the requestor, if any.\nIt is not guaranteed that the principal was allowed to use this authority.",
"type": "string"
+ },
+ "principalEmail": {
+ "description": "The email address of the authenticated user making the request.\nFor privacy reasons, the principal email address is redacted for all\nread-only operations that fail with a \"permission denied\" error.",
+ "type": "string"
}
},
- "id": "AuthenticationInfo",
- "description": "Authentication information for the operation.",
- "type": "object"
+ "id": "AuthenticationInfo"
},
"AllocateQuotaResponse": {
"properties": {
- "operationId": {
- "description": "The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes.",
- "type": "string"
- },
- "serviceConfigId": {
- "description": "ID of the actual config used to process the request.",
- "type": "string"
- },
"allocateErrors": {
"description": "Indicates the decision of the allocate.",
"items": {
@@ -552,6 +1017,14 @@
"$ref": "MetricValueSet"
},
"type": "array"
+ },
+ "operationId": {
+ "description": "The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes.",
+ "type": "string"
+ },
+ "serviceConfigId": {
+ "description": "ID of the actual config used to process the request.",
+ "type": "string"
}
},
"id": "AllocateQuotaResponse",
@@ -562,19 +1035,18 @@
"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"
},
"QuotaError": {
- "type": "object",
"properties": {
"description": {
"description": "Free-form text that provides details on the cause of the error.",
@@ -585,22 +1057,6 @@
"type": "string"
},
"code": {
- "enumDescriptions": [
- "This is never used.",
- "Quota allocation failed.\nSame as google.rpc.Code.RESOURCE_EXHAUSTED.",
- "Quota release failed. This error is ONLY returned on a NORMAL release.\nMore formally: if a user requests a release of 10 tokens, but only\n5 tokens were previously allocated, in a BEST_EFFORT release, this will\nbe considered a success, 5 tokens will be released, and the result will\nbe \"Ok\". If this is done in NORMAL mode, no tokens will be released,\nand an OUT_OF_RANGE error will be returned.\nSame as google.rpc.Code.OUT_OF_RANGE.",
- "Consumer cannot access the service because the service requires active\nbilling.",
- "Consumer's project has been marked as deleted (soft deletion).",
- "Specified API key is invalid.",
- "Specified API Key has expired.",
- "Consumer's spatula header is invalid.",
- "The consumer's LOAS role is invalid.",
- "The consumer's LOAS role has no associated project.",
- "The backend server for looking up project id/number is unavailable.",
- "The backend server for checking service status is unavailable.",
- "The backend server for checking billing status is unavailable.",
- "The backend server for checking quota limits is unavailable."
- ],
"enum": [
"UNSPECIFIED",
"RESOURCE_EXHAUSTED",
@@ -618,48 +1074,69 @@
"QUOTA_SYSTEM_UNAVAILABLE"
],
"description": "Error code.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "This is never used.",
+ "Quota allocation failed.\nSame as google.rpc.Code.RESOURCE_EXHAUSTED.",
+ "Quota release failed. This error is ONLY returned on a NORMAL release.\nMore formally: if a user requests a release of 10 tokens, but only\n5 tokens were previously allocated, in a BEST_EFFORT release, this will\nbe considered a success, 5 tokens will be released, and the result will\nbe \"Ok\". If this is done in NORMAL mode, no tokens will be released,\nand an OUT_OF_RANGE error will be returned.\nSame as google.rpc.Code.OUT_OF_RANGE.",
+ "Consumer cannot access the service because the service requires active\nbilling.",
+ "Consumer's project has been marked as deleted (soft deletion).",
+ "Specified API key is invalid.",
+ "Specified API Key has expired.",
+ "Consumer's spatula header is invalid.",
+ "The consumer's LOAS role is invalid.",
+ "The consumer's LOAS role has no associated project.",
+ "The backend server for looking up project id/number is unavailable.",
+ "The backend server for checking service status is unavailable.",
+ "The backend server for checking billing status is unavailable.",
+ "The backend server for checking quota limits is unavailable."
+ ]
}
},
- "id": "QuotaError"
+ "id": "QuotaError",
+ "type": "object"
},
"RequestMetadata": {
- "id": "RequestMetadata",
"description": "Metadata about the request.",
"type": "object",
"properties": {
- "callerSuppliedUserAgent": {
- "description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.\nNOLINT",
- "type": "string"
- },
"callerIp": {
"description": "The IP address of the caller.\nFor caller from internet, this will be public IPv4 or IPv6 address.\nFor caller from GCE VM with external IP address, this will be the VM's\nexternal IP address. For caller from GCE VM without external IP address, if\nthe VM is in the same GCP organization (or project) as the accessed\nresource, `caller_ip` will be the GCE VM's internal IPv4 address, otherwise\nit will be redacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.",
"type": "string"
+ },
+ "callerSuppliedUserAgent": {
+ "description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.\nNOLINT",
+ "type": "string"
}
- }
+ },
+ "id": "RequestMetadata"
},
"CheckInfo": {
"properties": {
+ "consumerInfo": {
+ "$ref": "ConsumerInfo",
+ "description": "Consumer info of this check."
+ },
"unusedArguments": {
"description": "A list of fields and label keys that are ignored by the server.\nThe client doesn't need to send them for following requests to improve\nperformance and allow better aggregation.",
"items": {
"type": "string"
},
"type": "array"
- },
- "consumerInfo": {
- "$ref": "ConsumerInfo",
- "description": "Consumer info of this check."
}
},
"id": "CheckInfo",
"type": "object"
},
"ReleaseQuotaResponse": {
- "id": "ReleaseQuotaResponse",
- "description": "Response message for the ReleaseQuota method.",
- "type": "object",
"properties": {
+ "releaseErrors": {
+ "description": "Indicates the decision of the release.",
+ "items": {
+ "$ref": "QuotaError"
+ },
+ "type": "array"
+ },
"quotaMetrics": {
"description": "Quota metrics to indicate the result of release. Depending on the\nrequest, one or more of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric released amount\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_refund_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For allocation quota, value for each quota limit associated with\nthe metrics will be specified using the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
"items": {
@@ -674,35 +1151,23 @@
"serviceConfigId": {
"description": "ID of the actual config used to process the request.",
"type": "string"
- },
- "releaseErrors": {
- "description": "Indicates the decision of the release.",
- "items": {
- "$ref": "QuotaError"
- },
- "type": "array"
}
- }
+ },
+ "id": "ReleaseQuotaResponse",
+ "description": "Response message for the ReleaseQuota method.",
+ "type": "object"
},
"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."
+ "description": "Operation that describes the quota allocation.",
+ "$ref": "QuotaOperation"
},
"allocationMode": {
- "enumDescriptions": [
- "",
- "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, allocation error will be returned and no quota will be\nallocated.",
- "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, request does not fail but all available quota will be\nallocated.",
- "Only checks if there is enough quota available and does not change the\navailable quota. No lock is placed on the available quota either."
- ],
"enum": [
"UNSPECIFIED",
"NORMAL",
@@ -710,12 +1175,22 @@
"CHECK_ONLY"
],
"description": "Allocation mode for this operation.\nDeprecated: use QuotaMode inside the QuotaOperation.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, allocation error will be returned and no quota will be\nallocated.",
+ "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, request does not fail but all available quota will be\nallocated.",
+ "Only checks if there is enough quota available and does not change the\navailable quota. No lock is placed on the available quota either."
+ ]
}
},
- "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.",
@@ -729,9 +1204,7 @@
"type": "array"
}
},
- "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"
+ "id": "MetricValueSet"
},
"ReportError": {
"description": "Represents the processing error of one Operation in the request.",
@@ -749,22 +1222,56 @@
"id": "ReportError"
},
"StartReconciliationRequest": {
- "type": "object",
"properties": {
"reconciliationOperation": {
- "description": "Operation that describes the quota reconciliation.",
- "$ref": "QuotaOperation"
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota reconciliation."
},
"serviceConfigId": {
"description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
"type": "string"
}
},
- "id": "StartReconciliationRequest"
+ "id": "StartReconciliationRequest",
+ "type": "object"
},
"CheckError": {
"properties": {
"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": [
@@ -800,40 +1307,6 @@
"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": {
@@ -846,17 +1319,7 @@
"type": "object"
},
"QuotaInfo": {
- "id": "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"quotaConsumed": {
"additionalProperties": {
"format": "int32",
@@ -871,8 +1334,18 @@
"$ref": "MetricValueSet"
},
"type": "array"
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
- }
+ },
+ "id": "QuotaInfo",
+ "description": "Contains the quota information for a quota check response.",
+ "type": "object"
},
"ConsumerInfo": {
"description": "`ConsumerInfo` provides information about the consumer project.",
@@ -885,489 +1358,13 @@
}
},
"id": "ConsumerInfo"
- },
- "CheckRequest": {
- "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"
- },
- "requestProjectSettings": {
- "description": "Requests the project settings to be returned as part of the check response.",
- "type": "boolean"
- },
- "operation": {
- "$ref": "Operation",
- "description": "The operation to be checked."
- }
- },
- "id": "CheckRequest",
- "description": "Request message for the Check method.",
- "type": "object"
- },
- "QuotaOperation": {
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels describing the operation.",
- "type": "object"
- },
- "consumerId": {
- "type": "string",
- "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."
- },
- "operationId": {
- "description": "Identity of the operation. This is expected to be unique within the scope\nof the service that generated the operation, and guarantees idempotency in\ncase of retries.\n\nUUID version 4 is recommended, though not required. In scenarios where an\noperation is computed from existing information and an idempotent id is\ndesirable for deduplication purpose, UUID version 5 is recommended. See\nRFC 4122 for details.",
- "type": "string"
- },
- "quotaMode": {
- "enum": [
- "UNSPECIFIED",
- "NORMAL",
- "BEST_EFFORT",
- "CHECK_ONLY"
- ],
- "description": "Quota mode for this operation.",
- "type": "string",
- "enumDescriptions": [
- "",
- "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": {
- "type": "string",
- "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"
- },
- "quotaMetrics": {
- "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.",
- "items": {
- "$ref": "MetricValueSet"
- },
- "type": "array"
- }
- },
- "id": "QuotaOperation",
- "description": "Represents information regarding a quota operation.",
- "type": "object"
- },
- "EndReconciliationRequest": {
- "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"
- }
- },
- "id": "EndReconciliationRequest",
- "type": "object"
- },
- "ReportInfo": {
- "type": "object",
- "properties": {
- "operationId": {
- "description": "The Operation.operation_id value from the request.",
- "type": "string"
- },
- "quotaInfo": {
- "$ref": "QuotaInfo",
- "description": "Quota usage info when processing the `Operation`."
- }
- },
- "id": "ReportInfo"
- },
- "Operation": {
- "properties": {
- "operationId": {
- "description": "Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls\nCheck() and Report() on the same operation, the two calls should carry\nthe same id.\n\nUUID version 4 is recommended, though not required.\nIn scenarios where an operation is computed from existing information\nand an idempotent id is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC 4122 for details.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.",
- "type": "string"
- },
- "operationName": {
- "type": "string",
- "description": "Fully qualified name of the operation. Reserved for future use."
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Required. Start time of the operation.",
- "type": "string"
- },
- "importance": {
- "enumDescriptions": [
- "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
- "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
- "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
- ],
- "enum": [
- "LOW",
- "HIGH",
- "DEBUG"
- ],
- "description": "DO NOT USE. This is an experimental field.",
- "type": "string"
- },
- "resourceContainers": {
- "description": "DO NOT USE.\nThis field is not ready for use yet.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "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": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served (e.g. GAE, GCE, GKE)."
- },
- "logEntries": {
- "description": "Represents information to be logged.",
- "items": {
- "$ref": "LogEntry"
- },
- "type": "array"
- },
- "userLabels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "User defined labels for the resource that this operation is associated\nwith.",
- "type": "object"
- },
- "metricValueSets": {
- "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.",
- "items": {
- "$ref": "MetricValueSet"
- },
- "type": "array"
- },
- "quotaProperties": {
- "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request.",
- "$ref": "QuotaProperties"
- },
- "consumerId": {
- "description": "Identity of the consumer who is using the service.\nThis field should be filled in for the operations initiated by a\nconsumer, but not for service-initiated operations that are\nnot related to a specific consumer.\n\nThis can be in one of the following formats:\n project:\u003cproject_id\u003e,\n project_number:\u003cproject_number\u003e,\n api_key:\u003capi_key\u003e.",
- "type": "string"
- }
- },
- "id": "Operation",
- "description": "Represents information regarding an operation.",
- "type": "object"
- },
- "ReportResponse": {
- "properties": {
- "reportInfos": {
- "description": "Quota usage for each quota release `Operation` request.\n\nFully or partially failed quota release request may or may not be present\nin `report_quota_info`. For example, a failed quota release request will\nhave the current quota usage info when precise quota library returns the\ninfo. A deadline exceeded quota request will not have quota usage info.\n\nIf there is no quota release request, report_quota_info will be empty.\n",
- "items": {
- "$ref": "ReportInfo"
- },
- "type": "array"
- },
- "serviceConfigId": {
- "description": "The actual config id used to process the request.",
- "type": "string"
- },
- "reportErrors": {
- "description": "Partial failures, one for each `Operation` in the request that failed\nprocessing. There are three possible combinations of the RPC status:\n\n1. The combination of a successful RPC status and an empty `report_errors`\n list indicates a complete success where all `Operations` in the\n request are processed successfully.\n2. The combination of a successful RPC status and a non-empty\n `report_errors` list indicates a partial success where some\n `Operations` in the request succeeded. Each\n `Operation` that failed processing has a corresponding item\n in this list.\n3. A failed RPC status indicates a general non-deterministic failure.\n When this happens, it's impossible to know which of the\n 'Operations' in the request succeeded or failed.",
- "items": {
- "$ref": "ReportError"
- },
- "type": "array"
- }
- },
- "id": "ReportResponse",
- "description": "Response message for the Report method.",
- "type": "object"
- },
- "CheckResponse": {
- "description": "Response message for the Check method.",
- "type": "object",
- "properties": {
- "checkInfo": {
- "$ref": "CheckInfo",
- "description": "Feedback data returned from the server during processing a Check request."
- },
- "checkErrors": {
- "description": "Indicate the decision of the check.\n\nIf no check errors are present, the service should process the operation.\nOtherwise the service should use the list of errors to determine the\nappropriate action.",
- "items": {
- "$ref": "CheckError"
- },
- "type": "array"
- },
- "operationId": {
- "type": "string",
- "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes."
- },
- "serviceConfigId": {
- "description": "The actual config id used to process the request.",
- "type": "string"
- },
- "quotaInfo": {
- "description": "Quota information for the check request associated with this response.\n",
- "$ref": "QuotaInfo"
- }
- },
- "id": "CheckResponse"
- },
- "Status": {
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "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"
- }
- }
- },
- "ReportRequest": {
- "type": "object",
- "properties": {
- "serviceConfigId": {
- "type": "string",
- "description": "Specifies which version of service config should be used to process the\nrequest.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used."
- },
- "operations": {
- "description": "Operations to be reported.\n\nTypically the service should report one operation per request.\nPutting multiple operations into a single request is allowed, but should\nbe used only when multiple operations are natually available at the time\nof the report.\n\nIf multiple operations are in a single request, the total request size\nshould be no larger than 1MB. See ReportResponse.report_errors for\npartial failure behavior.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
- }
- },
- "id": "ReportRequest",
- "description": "Request message for the Report method."
- },
- "LogEntry": {
- "description": "An individual log entry.",
- "type": "object",
- "properties": {
- "textPayload": {
- "description": "The log entry payload, represented as a Unicode string (UTF-8).",
- "type": "string"
- },
- "protoPayload": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.",
- "type": "object"
- },
- "timestamp": {
- "format": "google-datetime",
- "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
- "type": "object"
- },
- "severity": {
- "type": "string",
- "enumDescriptions": [
- "(0) The log entry has no assigned severity level.",
- "(100) Debug or trace information.",
- "(200) Routine information, such as ongoing status or performance.",
- "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
- "(400) Warning events might cause problems.",
- "(500) Error events are likely to cause problems.",
- "(600) Critical events cause more severe problems or outages.",
- "(700) A person must take an action immediately.",
- "(800) One or more systems are unusable."
- ],
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ],
- "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`."
- },
- "name": {
- "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
- "type": "string"
- },
- "insertId": {
- "type": "string",
- "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id."
- },
- "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"
- }
- },
- "id": "LogEntry"
- },
- "AuditLog": {
- "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
- "type": "object",
- "properties": {
- "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"
- },
- "authorizationInfo": {
- "description": "Authorization information. If there are multiple\nresources or permissions involved, then there is\none AuthorizationInfo element for each {resource, permission} tuple.",
- "items": {
- "$ref": "AuthorizationInfo"
- },
- "type": "array"
- },
- "resourceName": {
- "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"",
- "type": "string"
- },
- "request": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object"
- },
- "requestMetadata": {
- "description": "Metadata about the operation.",
- "$ref": "RequestMetadata"
- },
- "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"
- }
- },
- "numResponseItems": {
- "format": "int64",
- "description": "The number of items returned from a List or Query API method,\nif applicable.",
- "type": "string"
- },
- "authenticationInfo": {
- "$ref": "AuthenticationInfo",
- "description": "Authentication information."
- },
- "status": {
- "$ref": "Status",
- "description": "The status of the overall operation."
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object"
- },
- "serviceName": {
- "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
- "type": "string"
- }
- },
- "id": "AuditLog"
- },
- "MetricValue": {
- "description": "Represents a single metric value.",
- "type": "object",
- "properties": {
- "moneyValue": {
- "$ref": "Money",
- "description": "A money value."
- },
- "stringValue": {
- "description": "A text string value.",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.",
- "type": "object"
- },
- "doubleValue": {
- "format": "double",
- "description": "A double precision floating point value.",
- "type": "number"
- },
- "int64Value": {
- "format": "int64",
- "description": "A signed 64-bit integer value.",
- "type": "string"
- },
- "distributionValue": {
- "$ref": "Distribution",
- "description": "A distribution value."
- },
- "boolValue": {
- "type": "boolean",
- "description": "A boolean value."
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The end of the time period over which this metric value's measurement\napplies.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
- "type": "string"
- }
- },
- "id": "MetricValue"
}
},
- "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": "Service Control",
"auth": {
"oauth2": {
@@ -1383,5 +1380,8 @@
},
"rootUrl": "https://servicecontrol.googleapis.com/",
"ownerDomain": "google.com",
- "name": "servicecontrol"
+ "name": "servicecontrol",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Service Control API"
}
diff --git a/servicemanagement/v1/servicemanagement-api.json b/servicemanagement/v1/servicemanagement-api.json
index 6d307c8..6c22748 100644
--- a/servicemanagement/v1/servicemanagement-api.json
+++ b/servicemanagement/v1/servicemanagement-api.json
@@ -1,8 +1,120 @@
{
- "ownerName": "Google",
"resources": {
"services": {
"methods": {
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^services/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}:setIamPolicy",
+ "id": "servicemanagement.services.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "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",
+ "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": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:disable"
+ },
+ "getIamPolicy": {
+ "flatPath": "v1/services/{servicesId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "servicemanagement.services.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^services/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ]
+ },
+ "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": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:undelete",
+ "path": "v1/services/{serviceName}:undelete",
+ "id": "servicemanagement.services.undelete"
+ },
"list": {
"path": "v1/services",
"id": "servicemanagement.services.list",
@@ -20,14 +132,14 @@
],
"parameters": {
"consumerId": {
+ "location": "query",
"description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:\u003cproject_id\u003e",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageToken": {
- "location": "query",
"description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"format": "int32",
@@ -44,57 +156,51 @@
"flatPath": "v1/services"
},
"create": {
+ "request": {
+ "$ref": "ManagedService"
+ },
+ "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Operation"
},
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
+ "parameters": {},
"flatPath": "v1/services",
- "id": "servicemanagement.services.create",
"path": "v1/services",
- "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
- "request": {
- "$ref": "ManagedService"
- }
+ "id": "servicemanagement.services.create"
},
"generateConfigReport": {
+ "request": {
+ "$ref": "GenerateConfigReportRequest"
+ },
+ "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.",
"response": {
"$ref": "GenerateConfigReportResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
+ "parameters": {},
"flatPath": "v1/services:generateConfigReport",
"id": "servicemanagement.services.generateConfigReport",
- "path": "v1/services:generateConfigReport",
- "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.",
- "request": {
- "$ref": "GenerateConfigReportRequest"
- }
+ "path": "v1/services:generateConfigReport"
},
"get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ManagedService"
- },
"parameterOrder": [
"serviceName"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
+ "response": {
+ "$ref": "ManagedService"
+ },
+ "httpMethod": "GET",
"parameters": {
"serviceName": {
"location": "path",
@@ -103,12 +209,22 @@
"required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
"flatPath": "v1/services/{serviceName}",
- "path": "v1/services/{serviceName}",
"id": "servicemanagement.services.get",
+ "path": "v1/services/{serviceName}",
"description": "Gets a managed service. Authentication is required unless the service is\npublic."
},
"testIamPermissions": {
+ "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"
},
@@ -133,21 +249,16 @@
],
"flatPath": "v1/services/{servicesId}:testIamPermissions",
"id": "servicemanagement.services.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
+ "path": "v1/{+resource}:testIamPermissions"
},
"getConfig": {
- "description": "Gets a service configuration (version) for a managed service.",
- "response": {
- "$ref": "Service"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"serviceName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Service"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
@@ -155,60 +266,34 @@
"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`.",
- "type": "string",
- "required": true
- },
"configId": {
"location": "query",
"description": "The id of the service configuration resource.",
"type": "string"
},
"view": {
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "type": "string",
"location": "query",
"enum": [
"BASIC",
"FULL"
- ],
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string"
- }
- },
- "flatPath": "v1/services/{serviceName}/config",
- "id": "servicemanagement.services.getConfig",
- "path": "v1/services/{serviceName}/config"
- },
- "enable": {
- "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": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"type": "string",
"required": true,
"location": "path"
}
},
- "flatPath": "v1/services/{serviceName}: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"
+ "flatPath": "v1/services/{serviceName}/config",
+ "path": "v1/services/{serviceName}/config",
+ "id": "servicemanagement.services.getConfig",
+ "description": "Gets a service configuration (version) for a managed service."
},
"delete": {
+ "flatPath": "v1/services/{serviceName}",
"id": "servicemanagement.services.delete",
"path": "v1/services/{serviceName}",
"description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
@@ -219,61 +304,31 @@
"serviceName"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
"parameters": {
"serviceName": {
- "location": "path",
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{serviceName}"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
"required": true,
- "pattern": "^services/[^/]+$",
"location": "path"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{servicesId}:setIamPolicy",
- "id": "servicemanagement.services.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
}
},
- "disable": {
+ "enable": {
"request": {
- "$ref": "DisableServiceRequest"
+ "$ref": "EnableServiceRequest"
},
- "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
- "response": {
- "$ref": "Operation"
- },
+ "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"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
@@ -281,108 +336,20 @@
"parameters": {
"serviceName": {
"location": "path",
- "description": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.",
+ "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
"type": "string",
"required": true
}
},
- "flatPath": "v1/services/{serviceName}:disable",
- "id": "servicemanagement.services.disable",
- "path": "v1/services/{serviceName}:disable"
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^services/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{servicesId}:getIamPolicy",
- "id": "servicemanagement.services.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- }
- },
- "undelete": {
- "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation\u003cresponse: UndeleteServiceResponse\u003e",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}:undelete",
- "id": "servicemanagement.services.undelete",
- "path": "v1/services/{serviceName}:undelete"
+ "flatPath": "v1/services/{serviceName}:enable",
+ "path": "v1/services/{serviceName}:enable",
+ "id": "servicemanagement.services.enable"
}
},
"resources": {
"configs": {
"methods": {
- "create": {
- "id": "servicemanagement.services.configs.create",
- "path": "v1/services/{serviceName}/configs",
- "request": {
- "$ref": "Service"
- },
- "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
- "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`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/services/{serviceName}/configs"
- },
"submit": {
- "request": {
- "$ref": "SubmitConfigSourceRequest"
- },
- "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e",
"response": {
"$ref": "Operation"
},
@@ -404,10 +371,14 @@
},
"flatPath": "v1/services/{serviceName}/configs:submit",
"id": "servicemanagement.services.configs.submit",
- "path": "v1/services/{serviceName}/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"
},
"get": {
- "httpMethod": "GET",
+ "description": "Gets a service configuration (version) for a managed service.",
"response": {
"$ref": "Service"
},
@@ -415,6 +386,7 @@
"serviceName",
"configId"
],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
@@ -423,41 +395,43 @@
],
"parameters": {
"serviceName": {
- "location": "path",
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"configId": {
- "location": "path",
"description": "The id of the service configuration resource.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"view": {
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "type": "string",
+ "location": "query",
"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."
+ "path": "v1/services/{serviceName}/configs/{configId}"
},
"list": {
+ "flatPath": "v1/services/{serviceName}/configs",
+ "path": "v1/services/{serviceName}/configs",
+ "id": "servicemanagement.services.configs.list",
"description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.",
- "response": {
- "$ref": "ListServiceConfigsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"serviceName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListServiceConfigsResponse"
+ },
"parameters": {
"serviceName": {
"location": "path",
@@ -466,15 +440,15 @@
"required": true
},
"pageToken": {
- "location": "query",
"description": "The token of the page to retrieve.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "The max number of items to include in the response list.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -482,43 +456,68 @@
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/service.management",
"https://www.googleapis.com/auth/service.management.readonly"
+ ]
+ },
+ "create": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
],
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"flatPath": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.list",
- "path": "v1/services/{serviceName}/configs"
+ "id": "servicemanagement.services.configs.create",
+ "path": "v1/services/{serviceName}/configs",
+ "request": {
+ "$ref": "Service"
+ },
+ "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST"
}
}
},
"consumers": {
"methods": {
"setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"response": {
"$ref": "Policy"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
"parameters": {
"resource": {
- "pattern": "^services/[^/]+/consumers/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^services/[^/]+/consumers/[^/]+$"
}
},
"flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
"id": "servicemanagement.services.consumers.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ "path": "v1/{+resource}:setIamPolicy"
},
"testIamPermissions": {
"response": {
@@ -528,45 +527,40 @@
"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.",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/service.management",
"https://www.googleapis.com/auth/service.management.readonly"
],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^services/[^/]+/consumers/[^/]+$",
+ "location": "path"
+ }
+ },
"flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions",
"id": "servicemanagement.services.consumers.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
- }
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
},
"getIamPolicy": {
- "response": {
- "$ref": "Policy"
+ "request": {
+ "$ref": "GetIamPolicyRequest"
},
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "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.",
- "type": "string",
- "required": true
- }
+ "response": {
+ "$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -574,66 +568,83 @@
"https://www.googleapis.com/auth/service.management",
"https://www.googleapis.com/auth/service.management.readonly"
],
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "required": true,
+ "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",
- "id": "servicemanagement.services.consumers.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"
- }
+ "id": "servicemanagement.services.consumers.getIamPolicy"
}
}
},
"rollouts": {
"methods": {
"get": {
- "httpMethod": "GET",
+ "description": "Gets a service configuration rollout.",
+ "response": {
+ "$ref": "Rollout"
+ },
"parameterOrder": [
"serviceName",
"rolloutId"
],
- "response": {
- "$ref": "Rollout"
- },
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true
- },
- "rolloutId": {
- "location": "path",
- "description": "The id of the rollout resource.",
- "type": "string",
- "required": true
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/service.management",
"https://www.googleapis.com/auth/service.management.readonly"
],
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "rolloutId": {
+ "description": "The id of the rollout resource.",
+ "type": "string",
+ "required": true,
+ "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."
+ "path": "v1/services/{serviceName}/rollouts/{rolloutId}"
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "serviceName"
- ],
+ "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
"response": {
"$ref": "ListServiceRolloutsResponse"
},
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
"parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "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",
- "required": true
+ "location": "query"
+ },
+ "serviceName": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`."
},
"pageToken": {
"location": "query",
@@ -645,23 +656,11 @@
"description": "The max number of items to include in the response list.",
"type": "integer",
"location": "query"
- },
- "filter": {
- "location": "query",
- "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'",
- "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
"flatPath": "v1/services/{serviceName}/rollouts",
- "path": "v1/services/{serviceName}/rollouts",
"id": "servicemanagement.services.rollouts.list",
- "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest."
+ "path": "v1/services/{serviceName}/rollouts"
},
"create": {
"request": {
@@ -681,10 +680,10 @@
],
"parameters": {
"serviceName": {
+ "location": "path",
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"flatPath": "v1/services/{serviceName}/rollouts",
@@ -698,68 +697,68 @@
"operations": {
"methods": {
"get": {
+ "httpMethod": "GET",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
"flatPath": "v1/operations/{operationsId}",
- "id": "servicemanagement.operations.get",
"path": "v1/{+name}",
+ "id": "servicemanagement.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
},
"list": {
+ "flatPath": "v1/operations",
+ "id": "servicemanagement.operations.list",
+ "path": "v1/operations",
+ "description": "Lists service operations that match the specified filter in the request.",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
- "parameters": {
- "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\")`",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "query",
- "description": "Not used.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
- "type": "integer"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
- "flatPath": "v1/operations",
- "id": "servicemanagement.operations.list",
- "path": "v1/operations",
- "description": "Lists service operations that match the specified filter in the request."
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "location": "query",
+ "description": "Not used."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100."
+ }
+ }
}
}
}
@@ -776,28 +775,28 @@
"default": "true",
"type": "boolean"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"callback": {
"location": "query",
@@ -820,20 +819,20 @@
"description": "Data format for response.",
"default": "json"
},
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"location": "query",
@@ -842,39 +841,38 @@
"type": "boolean"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"version": "v1",
"baseUrl": "https://servicemanagement.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.",
"servicePath": "",
+ "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",
"basePath": "",
- "id": "servicemanagement:v1",
- "revision": "20170819",
"documentationLink": "https://cloud.google.com/service-management/",
+ "revision": "20170819",
+ "id": "servicemanagement:v1",
"discoveryVersion": "v1",
"schemas": {
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "type": "object"
+ }
},
"type": "array"
},
@@ -888,7 +886,8 @@
"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."
},
"Binding": {
"description": "Associates `members` with a `role`.",
@@ -913,16 +912,18 @@
"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"
+ },
"authorizationUrl": {
"description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec.",
"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"
+ "type": "string",
+ "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com"
},
"id": {
"description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
@@ -931,80 +932,21 @@
"jwksUri": {
"description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
"type": "string"
- },
- "audiences": {
- "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
- "type": "string"
}
},
- "id": "AuthProvider"
+ "id": "AuthProvider",
+ "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
+ "type": "object"
},
"Service": {
+ "id": "Service",
"description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
"type": "object",
"properties": {
- "documentation": {
- "description": "Additional API documentation.",
- "$ref": "Documentation"
- },
- "monitoredResources": {
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "type": "array"
- },
- "logging": {
- "description": "Logging configuration.",
- "$ref": "Logging"
- },
- "enums": {
- "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
- "items": {
- "$ref": "Enum"
- },
- "type": "array"
- },
- "context": {
- "description": "Context configuration.",
- "$ref": "Context"
- },
- "id": {
- "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
+ "producerProjectId": {
+ "description": "The Google project that owns this service.",
"type": "string"
},
- "usage": {
- "description": "Configuration controlling usage of this service.",
- "$ref": "Usage"
- },
- "metrics": {
- "description": "Defines the metrics used by this service.",
- "items": {
- "$ref": "MetricDescriptor"
- },
- "type": "array"
- },
- "authentication": {
- "description": "Auth configuration.",
- "$ref": "Authentication"
- },
- "experimental": {
- "$ref": "Experimental",
- "description": "Experimental configuration."
- },
- "control": {
- "$ref": "Control",
- "description": "Configuration for the service control plane."
- },
- "configVersion": {
- "format": "uint32",
- "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`.",
- "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.",
"items": {
@@ -1012,17 +954,13 @@
},
"type": "array"
},
- "producerProjectId": {
- "description": "The Google project that owns this service.",
- "type": "string"
- },
"visibility": {
- "description": "API visibility configuration.",
- "$ref": "Visibility"
+ "$ref": "Visibility",
+ "description": "API visibility configuration."
},
"quota": {
- "description": "Quota configuration.",
- "$ref": "Quota"
+ "$ref": "Quota",
+ "description": "Quota configuration."
},
"name": {
"description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
@@ -1043,13 +981,6 @@
},
"type": "array"
},
- "logs": {
- "description": "Defines the logs used by this service.",
- "items": {
- "$ref": "LogDescriptor"
- },
- "type": "array"
- },
"apis": {
"description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
"items": {
@@ -1057,6 +988,13 @@
},
"type": "array"
},
+ "logs": {
+ "description": "Defines the logs used by this service.",
+ "items": {
+ "$ref": "LogDescriptor"
+ },
+ "type": "array"
+ },
"types": {
"description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
"items": {
@@ -1069,27 +1007,88 @@
"description": "Output only. The source information for this configuration if available."
},
"http": {
- "description": "HTTP configuration.",
- "$ref": "Http"
+ "$ref": "Http",
+ "description": "HTTP configuration."
+ },
+ "systemParameters": {
+ "description": "System parameter configuration.",
+ "$ref": "SystemParameters"
},
"backend": {
"$ref": "Backend",
"description": "API backend configuration."
},
- "systemParameters": {
- "$ref": "SystemParameters",
- "description": "System parameter configuration."
+ "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.",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "type": "array"
+ },
+ "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",
+ "items": {
+ "$ref": "Enum"
+ },
+ "type": "array"
+ },
+ "context": {
+ "$ref": "Context",
+ "description": "Context configuration."
+ },
+ "id": {
+ "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
+ "type": "string"
+ },
+ "usage": {
+ "$ref": "Usage",
+ "description": "Configuration controlling usage of this service."
+ },
+ "metrics": {
+ "description": "Defines the metrics used by this service.",
+ "items": {
+ "$ref": "MetricDescriptor"
+ },
+ "type": "array"
+ },
+ "authentication": {
+ "$ref": "Authentication",
+ "description": "Auth configuration."
+ },
+ "experimental": {
+ "$ref": "Experimental",
+ "description": "Experimental configuration."
+ },
+ "control": {
+ "$ref": "Control",
+ "description": "Configuration for the service control plane."
+ },
+ "configVersion": {
+ "type": "integer",
+ "format": "uint32",
+ "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`."
+ },
+ "monitoring": {
+ "$ref": "Monitoring",
+ "description": "Monitoring configuration."
}
- },
- "id": "Service"
+ }
},
"EnumValue": {
"description": "Enum value definition.",
"type": "object",
"properties": {
"name": {
- "description": "Enum value name.",
- "type": "string"
+ "type": "string",
+ "description": "Enum value name."
},
"options": {
"description": "Protocol buffer options.",
@@ -1128,6 +1127,20 @@
"description": "The metadata associated with a long running operation resource.",
"type": "object",
"properties": {
+ "steps": {
+ "description": "Detailed status information for each step. The order is undetermined.",
+ "items": {
+ "$ref": "Step"
+ },
+ "type": "array"
+ },
+ "resourceNames": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "The full name of the resources that this operation is directly\nassociated with."
+ },
"progressPercentage": {
"format": "int32",
"description": "Percentage of completion of this operation, ranging from 0 to 100.",
@@ -1137,33 +1150,19 @@
"format": "google-datetime",
"description": "The start time of the operation.",
"type": "string"
- },
- "steps": {
- "description": "Detailed status information for each step. The order is undetermined.",
- "items": {
- "$ref": "Step"
- },
- "type": "array"
- },
- "resourceNames": {
- "description": "The full name of the resources that this operation is directly\nassociated with.",
- "items": {
- "type": "string"
- },
- "type": "array"
}
},
"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"
+ },
+ "kind": {
+ "description": "The name of this custom HTTP verb.",
+ "type": "string"
}
},
"id": "CustomHttpPattern",
@@ -1204,18 +1203,28 @@
"id": "VisibilityRule"
},
"HttpRule": {
+ "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
+ "type": "object",
"properties": {
+ "put": {
+ "description": "Used for updating a resource.",
+ "type": "string"
+ },
+ "delete": {
+ "description": "Used for deleting a resource.",
+ "type": "string"
+ },
"body": {
"description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
"type": "string"
},
- "post": {
- "description": "Used for creating a resource.",
- "type": "string"
- },
"mediaDownload": {
- "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration.",
- "$ref": "MediaDownload"
+ "$ref": "MediaDownload",
+ "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
+ },
+ "post": {
+ "type": "string",
+ "description": "Used for creating a resource."
},
"additionalBindings": {
"description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
@@ -1237,63 +1246,56 @@
"type": "string"
},
"custom": {
- "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients.",
- "$ref": "CustomHttpPattern"
- },
- "get": {
- "description": "Used for listing and getting information about resources.",
- "type": "string"
+ "$ref": "CustomHttpPattern",
+ "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients."
},
"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.",
+ "get": {
+ "description": "Used for listing and getting information about resources.",
"type": "string"
}
},
- "id": "HttpRule",
- "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
- "type": "object"
+ "id": "HttpRule"
},
"MonitoringDestination": {
- "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
- "type": "object",
"properties": {
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
- },
"metrics": {
"description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
+ "type": "string"
}
},
- "id": "MonitoringDestination"
+ "id": "MonitoringDestination",
+ "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
+ "type": "object"
},
"Visibility": {
+ "id": "Visibility",
+ "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
+ "type": "object",
"properties": {
"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.",
"items": {
"$ref": "VisibilityRule"
},
- "type": "array"
+ "type": "array",
+ "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
}
- },
- "id": "Visibility",
- "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
- "type": "object"
+ }
},
"SystemParameters": {
+ "id": "SystemParameters",
+ "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
+ "type": "object",
"properties": {
"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.",
@@ -1302,39 +1304,10 @@
},
"type": "array"
}
- },
- "id": "SystemParameters",
- "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
- "type": "object"
+ }
},
"ConfigChange": {
- "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.",
- "type": "object",
"properties": {
- "newValue": {
- "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
- "type": "string"
- },
- "changeType": {
- "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"
- },
"advices": {
"description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.",
"items": {
@@ -1345,11 +1318,39 @@
"oldValue": {
"description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
"type": "string"
+ },
+ "newValue": {
+ "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
+ "type": "string"
+ },
+ "changeType": {
+ "enumDescriptions": [
+ "No value was provided.",
+ "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.",
+ "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.",
+ "The changed object exists in both service configurations, but its value\nis different."
+ ],
+ "enum": [
+ "CHANGE_TYPE_UNSPECIFIED",
+ "ADDED",
+ "REMOVED",
+ "MODIFIED"
+ ],
+ "description": "The type for this change, either ADDED, REMOVED, or MODIFIED.",
+ "type": "string"
+ },
+ "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"
+ "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"
},
"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.",
@@ -1366,43 +1367,12 @@
"type": "array"
}
},
- "id": "Quota",
- "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
- "type": "object"
+ "id": "Quota"
},
"Rollout": {
+ "type": "object",
"properties": {
- "createdBy": {
- "description": "The user who created the Rollout. Readonly.",
- "type": "string"
- },
- "trafficPercentStrategy": {
- "description": "Google Service Control selects service configurations based on\ntraffic percentage.",
- "$ref": "TrafficPercentStrategy"
- },
- "rolloutId": {
- "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of \u003cdate\u003e\u003crevision number\u003e, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'",
- "type": "string"
- },
- "deleteServiceStrategy": {
- "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly.",
- "$ref": "DeleteServiceStrategy"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Creation time of the rollout. Readonly.",
- "type": "string"
- },
"status": {
- "enum": [
- "ROLLOUT_STATUS_UNSPECIFIED",
- "IN_PROGRESS",
- "SUCCESS",
- "CANCELLED",
- "FAILED",
- "PENDING",
- "FAILED_ROLLED_BACK"
- ],
"description": "The status of this rollout. Readonly. In case of a failed rollout,\nthe system will automatically rollback to the current Rollout\nversion. Readonly.",
"type": "string",
"enumDescriptions": [
@@ -1413,19 +1383,58 @@
"The Rollout has failed and the rollback attempt has failed too.",
"The Rollout has not started yet and is pending for execution.",
"The Rollout has failed and rolled back to the previous successful\nRollout."
+ ],
+ "enum": [
+ "ROLLOUT_STATUS_UNSPECIFIED",
+ "IN_PROGRESS",
+ "SUCCESS",
+ "CANCELLED",
+ "FAILED",
+ "PENDING",
+ "FAILED_ROLLED_BACK"
]
},
"serviceName": {
- "description": "The name of the service associated with this Rollout.",
+ "type": "string",
+ "description": "The name of the service associated with this Rollout."
+ },
+ "trafficPercentStrategy": {
+ "$ref": "TrafficPercentStrategy",
+ "description": "Google Service Control selects service configurations based on\ntraffic percentage."
+ },
+ "createdBy": {
+ "description": "The user who created the Rollout. Readonly.",
+ "type": "string"
+ },
+ "rolloutId": {
+ "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'"
+ },
+ "deleteServiceStrategy": {
+ "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly.",
+ "$ref": "DeleteServiceStrategy"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Creation time of the rollout. Readonly.",
"type": "string"
}
},
"id": "Rollout",
- "description": "A rollout resource that defines how service configuration versions are pushed\nto control plane systems. Typically, you create a new version of the\nservice config, and then create a Rollout to push the service config.",
- "type": "object"
+ "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."
},
"GenerateConfigReportRequest": {
+ "description": "Request message for GenerateConfigReport method.",
+ "type": "object",
"properties": {
+ "oldConfig": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service"
+ },
"newConfig": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -1433,51 +1442,35 @@
},
"description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
"type": "object"
- },
- "oldConfig": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
- "type": "object"
}
},
- "id": "GenerateConfigReportRequest",
- "description": "Request message for GenerateConfigReport method.",
- "type": "object"
+ "id": "GenerateConfigReportRequest"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
"updateMask": {
"format": "google-fieldmask",
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"type": "string"
- },
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
}
},
"id": "SetIamPolicyRequest"
},
"Step": {
+ "description": "Represents the status of one operation step.",
+ "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."
- ],
"enum": [
"STATUS_UNSPECIFIED",
"DONE",
@@ -1487,12 +1480,18 @@
"CANCELLED"
],
"description": "The status code.",
- "type": "string"
+ "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."
+ ]
}
},
- "id": "Step",
- "description": "Represents the status of one operation step.",
- "type": "object"
+ "id": "Step"
},
"DeleteServiceStrategy": {
"description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
@@ -1501,8 +1500,6 @@
"id": "DeleteServiceStrategy"
},
"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 \"/\".",
@@ -1516,26 +1513,28 @@
"type": "string"
}
},
- "id": "LoggingDestination"
+ "id": "LoggingDestination",
+ "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
+ "type": "object"
},
"Option": {
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
- "type": "object",
"properties": {
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
- "type": "string"
- },
"value": {
+ "type": "object",
"additionalProperties": {
"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"
+ "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type."
+ },
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
+ "type": "string"
}
},
- "id": "Option"
+ "id": "Option",
+ "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
+ "type": "object"
},
"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",
@@ -1559,6 +1558,8 @@
"id": "Logging"
},
"QuotaLimit": {
+ "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
+ "type": "object",
"properties": {
"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.",
@@ -1574,14 +1575,14 @@
"description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
"type": "string"
},
- "metric": {
- "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
- "type": "string"
- },
"displayName": {
"description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
"type": "string"
},
+ "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"
@@ -1608,24 +1609,12 @@
"type": "string"
}
},
- "id": "QuotaLimit",
- "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
- "type": "object"
+ "id": "QuotaLimit"
},
"Method": {
+ "description": "Method represents a method of an API interface.",
+ "type": "object",
"properties": {
- "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"
@@ -1652,15 +1641,23 @@
"requestStreaming": {
"description": "If true, the request is streamed.",
"type": "boolean"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of this method.",
+ "type": "string"
}
},
- "id": "Method",
- "description": "Method represents a method of an API interface.",
- "type": "object"
+ "id": "Method"
},
"ListServiceRolloutsResponse": {
- "description": "Response message for ListServiceRollouts method.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The token of the next page of results.",
@@ -1674,7 +1671,9 @@
"type": "array"
}
},
- "id": "ListServiceRolloutsResponse"
+ "id": "ListServiceRolloutsResponse",
+ "description": "Response message for ListServiceRollouts method.",
+ "type": "object"
},
"ConfigRef": {
"description": "Represents a service configuration with its name and id.",
@@ -1688,43 +1687,24 @@
"id": "ConfigRef"
},
"Mixin": {
- "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
- "type": "object",
"properties": {
"name": {
- "description": "The fully qualified name of the interface which is included.",
- "type": "string"
+ "type": "string",
+ "description": "The fully qualified name of the interface which is included."
},
"root": {
"description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
"type": "string"
}
},
- "id": "Mixin"
+ "id": "Mixin",
+ "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
+ "type": "object"
},
"FlowOperationMetadata": {
"description": "The metadata associated with a long running operation resource.",
"type": "object",
"properties": {
- "deadline": {
- "format": "google-datetime",
- "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",
- "type": "string"
- },
- "cancelState": {
- "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.",
- "type": "string"
- },
"startTime": {
"format": "google-datetime",
"description": "The start time of the operation.",
@@ -1740,32 +1720,53 @@
"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"
+ },
+ "deadline": {
+ "type": "string",
+ "format": "google-datetime",
+ "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"
+ },
+ "cancelState": {
+ "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.",
+ "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'.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"rules": {
"description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
"$ref": "CustomErrorRule"
},
"type": "array"
+ },
+ "types": {
+ "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "CustomError",
- "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
- "type": "object"
+ "id": "CustomError"
},
"CounterOptions": {
+ "description": "Increment a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
+ "type": "object",
"properties": {
"field": {
"description": "The field value to attribute.",
@@ -1776,9 +1777,7 @@
"type": "string"
}
},
- "id": "CounterOptions",
- "description": "Increment a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
- "type": "object"
+ "id": "CounterOptions"
},
"Http": {
"description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
@@ -1817,6 +1816,7 @@
"id": "SourceInfo"
},
"Control": {
+ "type": "object",
"properties": {
"environment": {
"description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
@@ -1824,16 +1824,15 @@
}
},
"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"
+ "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": {
"name": {
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
- "type": "string"
+ "type": "string",
+ "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive."
},
"urlQueryParameter": {
"description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
@@ -1847,12 +1846,9 @@
"id": "SystemParameter"
},
"Field": {
+ "description": "A single field of a message type.",
+ "type": "object",
"properties": {
- "oneofIndex": {
- "format": "int32",
- "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
- "type": "integer"
- },
"packed": {
"description": "Whether to use alternative packed wire representation.",
"type": "boolean"
@@ -1882,8 +1878,8 @@
"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"
+ "type": "string",
+ "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`."
},
"number": {
"format": "int32",
@@ -1895,6 +1891,7 @@
"type": "string"
},
"kind": {
+ "type": "string",
"enumDescriptions": [
"Field type unknown.",
"Field type double.",
@@ -1937,8 +1934,7 @@
"TYPE_SINT32",
"TYPE_SINT64"
],
- "description": "The field type.",
- "type": "string"
+ "description": "The field type."
},
"options": {
"description": "The protocol buffer options.",
@@ -1946,11 +1942,14 @@
"$ref": "Option"
},
"type": "array"
+ },
+ "oneofIndex": {
+ "format": "int32",
+ "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
+ "type": "integer"
}
},
- "id": "Field",
- "description": "A single field of a message type.",
- "type": "object"
+ "id": "Field"
},
"Monitoring": {
"description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
@@ -1988,6 +1987,7 @@
"id": "TestIamPermissionsRequest"
},
"Enum": {
+ "type": "object",
"properties": {
"enumvalue": {
"description": "Enum value definitions.",
@@ -2008,6 +2008,8 @@
"type": "array"
},
"syntax": {
+ "description": "The source syntax.",
+ "type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
@@ -2015,37 +2017,19 @@
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string"
+ ]
},
"sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
+ "description": "The source context.",
+ "$ref": "SourceContext"
}
},
"id": "Enum",
- "description": "Enum type definition.",
- "type": "object"
+ "description": "Enum type definition."
},
"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"
@@ -2053,24 +2037,28 @@
"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"
+ "id": "LabelDescriptor",
+ "description": "A description of a label."
},
"Diagnostic": {
+ "type": "object",
"properties": {
- "kind": {
- "enum": [
- "WARNING",
- "ERROR"
- ],
- "description": "The kind of diagnostic information provided.",
- "type": "string",
- "enumDescriptions": [
- "Warnings and errors",
- "Only errors"
- ]
- },
"message": {
"description": "Message describing the error or warning.",
"type": "string"
@@ -2078,25 +2066,45 @@
"location": {
"description": "File name and line number of the error or warning.",
"type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "enumDescriptions": [
+ "Warnings and errors",
+ "Only errors"
+ ],
+ "enum": [
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "The kind of diagnostic information provided."
}
},
"id": "Diagnostic",
- "description": "Represents a diagnostic message (error or warning)",
- "type": "object"
+ "description": "Represents a diagnostic message (error or warning)"
},
"EnableServiceRequest": {
+ "description": "Request message for EnableService method.",
+ "type": "object",
"properties": {
"consumerId": {
"description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
"type": "string"
}
},
- "id": "EnableServiceRequest",
- "description": "Request message for EnableService method.",
- "type": "object"
+ "id": "EnableServiceRequest"
},
"Type": {
+ "description": "A protocol buffer message type.",
+ "type": "object",
"properties": {
+ "options": {
+ "description": "The protocol buffer options.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
+ },
"fields": {
"description": "The list of fields.",
"items": {
@@ -2116,8 +2124,8 @@
"type": "array"
},
"sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
+ "description": "The source context.",
+ "$ref": "SourceContext"
},
"syntax": {
"enumDescriptions": [
@@ -2130,25 +2138,12 @@
],
"description": "The source syntax.",
"type": "string"
- },
- "options": {
- "description": "The protocol buffer options.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
}
},
- "id": "Type",
- "description": "A protocol buffer message type.",
- "type": "object"
+ "id": "Type"
},
"GenerateConfigReportResponse": {
"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.",
"items": {
@@ -2166,6 +2161,10 @@
"$ref": "Diagnostic"
},
"type": "array"
+ },
+ "serviceName": {
+ "description": "Name of the service this report belongs to.",
+ "type": "string"
}
},
"id": "GenerateConfigReportResponse",
@@ -2173,6 +2172,9 @@
"type": "object"
},
"ListServiceConfigsResponse": {
+ "id": "ListServiceConfigsResponse",
+ "description": "Response message for ListServiceConfigs method.",
+ "type": "object",
"properties": {
"serviceConfigs": {
"description": "The list of service configuration resources.",
@@ -2185,30 +2187,23 @@
"description": "The token of the next page of results.",
"type": "string"
}
- },
- "id": "ListServiceConfigsResponse",
- "description": "Response message for ListServiceConfigs method.",
- "type": "object"
+ }
},
"Experimental": {
+ "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
+ "type": "object",
"properties": {
"authorization": {
- "$ref": "AuthorizationConfig",
- "description": "Authorization configuration."
+ "description": "Authorization configuration.",
+ "$ref": "AuthorizationConfig"
}
},
- "id": "Experimental",
- "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
- "type": "object"
+ "id": "Experimental"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
"items": {
@@ -2221,11 +2216,17 @@
"type": "string"
},
"type": "array"
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
}
},
"id": "AuditConfig"
},
"Backend": {
+ "description": "`Backend` defines the backend configuration for a service.",
+ "type": "object",
"properties": {
"rules": {
"description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
@@ -2235,12 +2236,9 @@
"type": "array"
}
},
- "id": "Backend",
- "description": "`Backend` defines the backend configuration for a service.",
- "type": "object"
+ "id": "Backend"
},
"SubmitConfigSourceRequest": {
- "description": "Request message for SubmitConfigSource method.",
"type": "object",
"properties": {
"configSource": {
@@ -2252,67 +2250,63 @@
"type": "boolean"
}
},
- "id": "SubmitConfigSourceRequest"
+ "id": "SubmitConfigSourceRequest",
+ "description": "Request message for SubmitConfigSource method."
},
"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",
- "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"
+ "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"
- },
- "description": {
- "description": "Description of the selected API(s).",
- "type": "string"
+ "type": "string",
+ "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used."
}
},
- "id": "DocumentationRule"
+ "id": "DocumentationRule",
+ "description": "A documentation rule provides information about individual API elements.",
+ "type": "object"
},
"CloudAuditOptions": {
+ "description": "Write a Cloud Audit log",
+ "type": "object",
"properties": {
"logName": {
- "enum": [
- "UNSPECIFIED_LOG_NAME",
- "ADMIN_ACTIVITY",
- "DATA_ACCESS"
- ],
"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",
- "description": "Write a Cloud Audit log",
- "type": "object"
+ "id": "CloudAuditOptions"
},
"ContextRule": {
- "description": "A context rule provides information about the context for an individual API\nelement.",
"type": "object",
"properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
"provided": {
"description": "A list of full type names of provided contexts.",
"items": {
@@ -2321,34 +2315,39 @@
"type": "array"
},
"requested": {
- "description": "A list of full type names of requested contexts.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "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"
+ "id": "ContextRule",
+ "description": "A context rule provides information about the context for an individual API\nelement."
},
"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."
- ]
+ ],
+ "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."
},
"description": {
"description": "A detailed description of the metric, which can be used in documentation.",
@@ -2378,6 +2377,8 @@
"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`.",
@@ -2395,23 +2396,21 @@
"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"
+ ]
}
},
"id": "MetricDescriptor"
},
"SourceContext": {
- "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
- "type": "object",
"properties": {
"fileName": {
"description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
"type": "string"
}
},
- "id": "SourceContext"
+ "id": "SourceContext",
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "type": "object"
},
"Expr": {
"properties": {
@@ -2428,8 +2427,8 @@
"type": "string"
},
"title": {
- "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
- "type": "string"
+ "type": "string",
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression."
}
},
"id": "Expr",
@@ -2437,7 +2436,6 @@
"type": "object"
},
"ListServicesResponse": {
- "description": "Response message for `ListServices` method.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -2452,60 +2450,63 @@
"type": "array"
}
},
- "id": "ListServicesResponse"
+ "id": "ListServicesResponse",
+ "description": "Response message for `ListServices` method."
},
"Endpoint": {
+ "id": "Endpoint",
"description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
"type": "object",
"properties": {
- "features": {
- "description": "The list of features enabled on this endpoint.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"apis": {
- "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration."
+ },
+ "aliases": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "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."
},
"allowCors": {
"description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
"type": "boolean"
},
- "aliases": {
- "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"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"
+ "type": "string",
+ "description": "The canonical name of this endpoint."
+ },
+ "features": {
+ "description": "The list of features enabled on this endpoint.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
- },
- "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",
- "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"
+ "id": "OAuthRequirements"
},
"TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -2515,28 +2516,29 @@
"type": "array"
}
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
+ "id": "TestIamPermissionsResponse"
},
"GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
"type": "object",
"properties": {},
- "id": "GetIamPolicyRequest"
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method."
},
"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"
+ "type": "string",
+ "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview."
},
"rules": {
- "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
"$ref": "UsageRule"
},
- "type": "array"
+ "type": "array",
+ "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'.",
@@ -2545,10 +2547,7 @@
},
"type": "array"
}
- },
- "id": "Usage",
- "description": "Configuration controlling usage of a service.",
- "type": "object"
+ }
},
"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`.",
@@ -2565,17 +2564,17 @@
"id": "Context"
},
"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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"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",
@@ -2585,15 +2584,7 @@
"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."
- ]
+ "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).",
@@ -2607,11 +2598,11 @@
"type": "string"
},
"conditions": {
- "description": "Additional restrictions that must be met",
"items": {
"$ref": "Condition"
},
- "type": "array"
+ "type": "array",
+ "description": "Additional restrictions that must be met"
},
"logConfig": {
"description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
@@ -2626,9 +2617,17 @@
"type": "string"
},
"type": "array"
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "Rule"
+ "id": "Rule",
+ "description": "A rule to be applied in a Policy."
},
"LogConfig": {
"description": "Specifies what kind of log the caller must write",
@@ -2643,14 +2642,23 @@
"description": "Counter options."
},
"dataAccess": {
- "description": "Data access options.",
- "$ref": "DataAccessOptions"
+ "$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.",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ },
"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"
@@ -2662,31 +2670,15 @@
"description": {
"description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
"type": "string"
- },
- "labels": {
- "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
}
},
- "id": "LogDescriptor",
- "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
- "type": "object"
+ "id": "LogDescriptor"
},
"ConfigFile": {
"description": "Generic specification of a source configuration file",
"type": "object",
"properties": {
"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",
@@ -2695,7 +2687,14 @@
"FILE_DESCRIPTOR_SET_PROTO"
],
"description": "The type of configuration file this represents.",
- "type": "string"
+ "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"
+ ]
},
"fileContents": {
"format": "byte",
@@ -2703,8 +2702,8 @@
"type": "string"
},
"filePath": {
- "description": "The file name of the configuration file (full or relative path).",
- "type": "string"
+ "type": "string",
+ "description": "The file name of the configuration file (full or relative path)."
}
},
"id": "ConfigFile"
@@ -2713,17 +2712,6 @@
"description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
"type": "object",
"properties": {
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
- "type": "string"
- },
"description": {
"description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
"type": "string"
@@ -2733,58 +2721,37 @@
"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",
+ "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters."
+ },
+ "labels": {
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array",
+ "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`."
+ },
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
"type": "string"
}
},
"id": "MonitoredResourceDescriptor"
},
"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"
+ "type": "string",
+ "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details."
},
"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"
}
},
- "id": "CustomErrorRule",
- "description": "A custom error rule.",
- "type": "object"
- },
- "MediaDownload": {
- "properties": {
- "useDirectDownload": {
- "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
- "type": "boolean"
- },
- "enabled": {
- "description": "Whether download is enabled.",
- "type": "boolean"
- },
- "downloadService": {
- "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
- "type": "string"
- },
- "completeNotification": {
- "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
- "type": "boolean"
- },
- "maxDirectDownloadSize": {
- "format": "int64",
- "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
- "type": "string"
- },
- "dropzone": {
- "description": "Name of the Scotty dropzone to use for the current API.",
- "type": "string"
- }
- },
- "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"
+ "id": "CustomErrorRule"
},
"CustomAuthRequirements": {
"description": "Configuration for a custom authentication provider.",
@@ -2797,10 +2764,40 @@
},
"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.",
+ "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": {
+ "type": "boolean",
+ "description": "Whether download is enabled."
+ },
+ "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": {
+ "format": "int64",
+ "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
+ "type": "string"
+ },
+ "useDirectDownload": {
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
+ "type": "boolean"
+ }
+ },
+ "id": "MediaDownload"
+ },
+ "ChangeReport": {
+ "properties": {
"configChanges": {
"description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
"items": {
@@ -2809,35 +2806,57 @@
"type": "array"
}
},
- "id": "ChangeReport"
+ "id": "ChangeReport",
+ "description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
+ "type": "object"
},
"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",
- "description": "Request message for DisableService method.",
- "type": "object"
+ "id": "DisableServiceRequest"
},
"SubmitConfigSourceResponse": {
"description": "Response message for SubmitConfigSource method.",
"type": "object",
"properties": {
"serviceConfig": {
- "$ref": "Service",
- "description": "The generated service configuration."
+ "description": "The generated service configuration.",
+ "$ref": "Service"
}
},
"id": "SubmitConfigSourceResponse"
},
"MediaUpload": {
+ "type": "object",
"properties": {
- "maxSize": {
- "format": "int64",
- "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
+ "type": "boolean"
+ },
+ "progressNotification": {
+ "description": "Whether to receive a notification for progress changes of media upload.",
+ "type": "boolean"
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether upload is enabled."
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ },
+ "startNotification": {
+ "type": "boolean",
+ "description": "Whether to receive a notification on the start of media upload."
+ },
+ "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": {
@@ -2847,47 +2866,29 @@
},
"type": "array"
},
- "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"
+ "maxSize": {
+ "type": "string",
+ "format": "int64",
+ "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes."
}
},
"id": "MediaUpload",
- "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
- "type": "object"
+ "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."
},
"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"
+ "type": "string",
+ "description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks."
}
},
- "id": "Advice",
- "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
- "type": "object"
+ "id": "Advice"
},
"ManagedService": {
+ "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
+ "type": "object",
"properties": {
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements.",
@@ -2898,40 +2899,38 @@
"type": "string"
}
},
- "id": "ManagedService",
- "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
- "type": "object"
+ "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": {
- "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"
+ "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."
},
"skipServiceControl": {
"description": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.",
"type": "boolean"
+ },
+ "allowUnregisteredCalls": {
+ "type": "boolean",
+ "description": "True, if the method allows unregistered calls; false otherwise."
}
},
- "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"
+ "id": "UsageRule"
},
"TrafficPercentStrategy": {
"description": "Strategy that specifies how clients of Google Service Controller want to\nsend traffic to use different config versions. This is generally\nused by API proxy to split traffic based on your configured precentage for\neach config version.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }",
"type": "object",
"properties": {
"percentages": {
+ "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
+ "type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
- },
- "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
- "type": "object"
+ }
}
},
"id": "TrafficPercentStrategy"
@@ -2940,38 +2939,20 @@
"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"
+ },
+ "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"
},
"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",
@@ -2979,16 +2960,28 @@
"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."
},
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "value": {
+ "description": "DEPRECATED. Use 'values' instead.",
+ "type": "string"
},
"iam": {
+ "enumDescriptions": [
+ "Default non-attribute.",
+ "Either principal or (if present) authority selector.",
+ "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
+ "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).",
+ "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",
@@ -2997,24 +2990,16 @@
"JUSTIFICATION_TYPE"
],
"description": "Trusted attributes supplied by the IAM system.",
- "type": "string",
- "enumDescriptions": [
- "Default non-attribute.",
- "Either principal or (if present) authority selector.",
- "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
- "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).",
- "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."
- ]
+ "type": "string"
+ },
+ "values": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "The objects of the condition. This is mutually exclusive with 'value'."
},
"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",
@@ -3024,18 +3009,32 @@
"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"
}
},
- "id": "Condition"
+ "id": "Condition",
+ "description": "A condition to be met.",
+ "type": "object"
},
"Documentation": {
"description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
"type": "object",
"properties": {
"documentationRootUrl": {
- "description": "The URL to the root of documentation.",
- "type": "string"
+ "type": "string",
+ "description": "The URL to the root of documentation."
},
"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.",
@@ -3063,34 +3062,34 @@
"id": "Documentation"
},
"AuditLogConfig": {
+ "id": "AuditLogConfig",
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
"properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"logType": {
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
"type": "string",
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
- ]
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables."
+ },
+ "exemptedMembers": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members."
}
- },
- "id": "AuditLogConfig",
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object"
+ }
},
"ConfigSource": {
"description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
@@ -3111,6 +3110,8 @@
"id": "ConfigSource"
},
"BackendRule": {
+ "description": "A backend rule provides configuration for an individual API element.",
+ "type": "object",
"properties": {
"minDeadline": {
"format": "double",
@@ -3131,14 +3132,19 @@
"type": "number"
}
},
- "id": "BackendRule",
- "description": "A backend rule provides configuration for an individual API element.",
- "type": "object"
+ "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.",
+ "items": {
+ "$ref": "AuthRequirement"
+ },
+ "type": "array"
+ },
"allowWithoutCredential": {
"description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
"type": "boolean"
@@ -3148,53 +3154,20 @@
"type": "string"
},
"customAuth": {
- "$ref": "CustomAuthRequirements",
- "description": "Configuration for custom authentication."
+ "description": "Configuration for custom authentication.",
+ "$ref": "CustomAuthRequirements"
},
"oauth": {
- "description": "The requirements for OAuth credentials.",
- "$ref": "OAuthRequirements"
- },
- "requirements": {
- "description": "Requirements for additional authentication providers.",
- "items": {
- "$ref": "AuthRequirement"
- },
- "type": "array"
+ "$ref": "OAuthRequirements",
+ "description": "The requirements for OAuth credentials."
}
},
"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": {
- "etag": {
- "format": "byte",
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "type": "string"
- },
- "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.",
- "items": {
- "$ref": "Rule"
- },
- "type": "array"
- },
"version": {
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
@@ -3213,34 +3186,55 @@
"$ref": "Binding"
},
"type": "array"
+ },
+ "etag": {
+ "format": "byte",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "type": "string"
+ },
+ "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.",
+ "items": {
+ "$ref": "Rule"
+ },
+ "type": "array"
}
},
"id": "Policy"
},
- "Api": {
+ "UndeleteServiceResponse": {
+ "description": "Response message for UndeleteService method.",
+ "type": "object",
"properties": {
- "methods": {
- "description": "The methods of this interface, in unspecified order.",
- "items": {
- "$ref": "Method"
- },
- "type": "array"
- },
+ "service": {
+ "$ref": "ManagedService",
+ "description": "Revived service resource."
+ }
+ },
+ "id": "UndeleteServiceResponse"
+ },
+ "Api": {
+ "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
+ "type": "object",
+ "properties": {
"name": {
"description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
"type": "string"
},
"syntax": {
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
"description": "The source syntax of the service.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ]
},
"sourceContext": {
"description": "Source context for the protocol buffer service represented by this\nmessage.",
@@ -3258,23 +3252,30 @@
"type": "array"
},
"options": {
- "description": "Any metadata attached to the interface.",
"items": {
"$ref": "Option"
},
+ "type": "array",
+ "description": "Any metadata attached to the interface."
+ },
+ "methods": {
+ "description": "The methods of this interface, in unspecified order.",
+ "items": {
+ "$ref": "Method"
+ },
"type": "array"
}
},
- "id": "Api",
- "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
- "type": "object"
+ "id": "Api"
},
"MetricRule": {
+ "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
+ "type": "object",
"properties": {
"metricCosts": {
"additionalProperties": {
- "format": "int64",
- "type": "string"
+ "type": "string",
+ "format": "int64"
},
"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"
@@ -3284,15 +3285,15 @@
"type": "string"
}
},
- "id": "MetricRule",
- "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
- "type": "object"
+ "id": "MetricRule"
},
"DataAccessOptions": {
"description": "Write a Data Access (Gin) log",
"type": "object",
"properties": {
"logMode": {
+ "description": "Whether Gin logging should happen in a fail-closed manner at the caller.\nThis is relevant only in the LocalIAM implementation, for now.",
+ "type": "string",
"enumDescriptions": [
"Client is not required to write a partial Gin log immediately after\nthe authorization check. If client chooses to write one and it fails,\nclient may either fail open (allow the operation to continue) or\nfail closed (handle as a DENY outcome).",
"The application's operation in the context of which this authorization\ncheck is being made may only be performed if it is successfully logged\nto Gin. For instance, the authorization library may satisfy this\nobligation by emitting a partial log entry at authorization check time\nand only returning ALLOW to the application if it succeeds.\n\nIf a matching Rule has this directive, but the client has not indicated\nthat it will honor such requirements, then the IAM check will result in\nauthorization failure by setting CheckPolicyResponse.success=false."
@@ -3300,9 +3301,7 @@
"enum": [
"LOG_MODE_UNSPECIFIED",
"LOG_FAIL_CLOSED"
- ],
- "description": "Whether Gin logging should happen in a fail-closed manner at the caller.\nThis is relevant only in the LocalIAM implementation, for now.",
- "type": "string"
+ ]
}
},
"id": "DataAccessOptions"
@@ -3329,14 +3328,20 @@
"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"
- },
- "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`.",
@@ -3347,28 +3352,20 @@
"$ref": "Status"
},
"metadata": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "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"
+ "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.",
- "type": "object"
+ "id": "Operation"
},
"Page": {
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
+ "type": "object",
"properties": {
- "name": {
- "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
- "type": "string"
- },
"content": {
"description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
"type": "string"
@@ -3379,18 +3376,20 @@
"$ref": "Page"
},
"type": "array"
+ },
+ "name": {
+ "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
+ "type": "string"
}
},
- "id": "Page",
- "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
- "type": "object"
+ "id": "Page"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Service Management",
"auth": {
"oauth2": {
@@ -3415,5 +3414,6 @@
"name": "servicemanagement",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Google Service Management API"
+ "title": "Google Service Management API",
+ "ownerName": "Google"
}
diff --git a/serviceuser/v1/serviceuser-api.json b/serviceuser/v1/serviceuser-api.json
index 0374bc0..a691d12 100644
--- a/serviceuser/v1/serviceuser-api.json
+++ b/serviceuser/v1/serviceuser-api.json
@@ -1,794 +1,5 @@
{
- "resources": {
- "projects": {
- "resources": {
- "services": {
- "methods": {
- "disable": {
- "id": "serviceuser.projects.services.disable",
- "path": "v1/{+name}:disable",
- "request": {
- "$ref": "DisableServiceRequest"
- },
- "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/services/[^/]+$",
- "location": "path",
- "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable"
- },
- "enable": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "name": {
- "description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:enable",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/services/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable",
- "id": "serviceuser.projects.services.enable",
- "path": "v1/{+name}: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": {
- "response": {
- "$ref": "ListEnabledServicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Requested size of the next page of data.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/services",
- "id": "serviceuser.projects.services.list",
- "path": "v1/{+parent}/services",
- "description": "List enabled services for the specified consumer."
- }
- }
- }
- }
- },
- "services": {
- "methods": {
- "search": {
- "flatPath": "v1/services:search",
- "id": "serviceuser.services.search",
- "path": "v1/services:search",
- "description": "Search available services.\n\nWhen no filter is specified, returns all accessible services. For\nauthenticated users, also returns all services the calling user has\n\"servicemanagement.services.bind\" permission for.",
- "response": {
- "$ref": "SearchServicesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Requested size of the next page of data."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://serviceuser.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
- "servicePath": "",
- "basePath": "",
- "id": "serviceuser:v1",
- "documentationLink": "https://cloud.google.com/service-management/",
- "revision": "20170819",
- "discoveryVersion": "v1",
- "version_module": true,
"schemas": {
- "ListEnabledServicesResponse": {
- "description": "Response message for `ListEnabledServices` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
- "type": "string"
- },
- "services": {
- "description": "Services enabled for the specified parent.",
- "items": {
- "$ref": "PublishedService"
- },
- "type": "array"
- }
- },
- "id": "ListEnabledServicesResponse"
- },
- "Endpoint": {
- "id": "Endpoint",
- "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
- "type": "object",
- "properties": {
- "allowCors": {
- "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
- "type": "boolean"
- },
- "aliases": {
- "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "features": {
- "description": "The list of features enabled on this endpoint.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "apis": {
- "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "OAuthRequirements": {
- "id": "OAuthRequirements",
- "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
- "type": "object",
- "properties": {
- "canonicalScopes": {
- "type": "string",
- "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"
- }
- }
- },
- "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.",
- "items": {
- "$ref": "UsageRule"
- },
- "type": "array"
- },
- "requirements": {
- "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "Context": {
- "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "items": {
- "$ref": "ContextRule"
- },
- "type": "array"
- }
- },
- "id": "Context"
- },
- "LogDescriptor": {
- "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.",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- },
- "name": {
- "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
- "type": "string"
- },
- "displayName": {
- "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
- "type": "string"
- },
- "description": {
- "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
- "type": "string"
- }
- },
- "id": "LogDescriptor",
- "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
- "type": "object"
- },
- "MonitoredResourceDescriptor": {
- "properties": {
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
- "type": "string"
- },
- "description": {
- "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
- "type": "string"
- },
- "displayName": {
- "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
- "type": "string"
- },
- "type": {
- "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
- "type": "string"
- },
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- }
- },
- "id": "MonitoredResourceDescriptor",
- "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"
- },
- "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": {
- "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": {
- "description": "Name of the Scotty dropzone to use for the current API.",
- "type": "string"
- },
- "maxDirectDownloadSize": {
- "format": "int64",
- "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
- "type": "string"
- },
- "useDirectDownload": {
- "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
- "type": "boolean"
- }
- },
- "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"
- },
- "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"
- },
- "DisableServiceRequest": {
- "type": "object",
- "properties": {},
- "id": "DisableServiceRequest",
- "description": "Request message for DisableService method."
- },
- "AuthorizationRule": {
- "description": "Authorization rule for API services.\n\nIt specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource.\n\nFor example:\n\n package google.storage.v1;\n\n message CopyObjectRequest {\n string source = 1 [\n (google.api.authz).permissions = \"storage.objects.get\"];\n\n string destination = 2 [\n (google.api.authz).permissions =\n \"storage.objects.create,storage.objects.update\"];\n }",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the API elements to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "permissions": {
- "description": "The required permissions. The acceptable values vary depend on the\nauthorization system used. For Google APIs, it should be a comma-separated\nGoogle IAM permission values. When multiple permissions are listed, the\nsemantics is not defined by the system. Additional documentation must\nbe provided manually.",
- "type": "string"
- }
- },
- "id": "AuthorizationRule"
- },
- "SearchServicesResponse": {
- "description": "Response message for SearchServices method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
- "type": "string"
- },
- "services": {
- "description": "Services available publicly or available to the authenticated caller.",
- "items": {
- "$ref": "PublishedService"
- },
- "type": "array"
- }
- },
- "id": "SearchServicesResponse"
- },
- "MediaUpload": {
- "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
- "type": "object",
- "properties": {
- "startNotification": {
- "type": "boolean",
- "description": "Whether to receive a notification on the start of media upload."
- },
- "uploadService": {
- "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
- "type": "string"
- },
- "maxSize": {
- "format": "int64",
- "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
- "type": "string"
- },
- "mimeTypes": {
- "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "completeNotification": {
- "type": "boolean",
- "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota."
- },
- "progressNotification": {
- "description": "Whether to receive a notification for progress changes of media upload.",
- "type": "boolean"
- },
- "enabled": {
- "description": "Whether upload is enabled.",
- "type": "boolean"
- },
- "dropzone": {
- "description": "Name of the Scotty dropzone to use for the current API.",
- "type": "string"
- }
- },
- "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"
- },
- "skipServiceControl": {
- "description": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.",
- "type": "boolean"
- },
- "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": {
- "audiences": {
- "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
- "type": "string"
- },
- "providerId": {
- "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
- "type": "string"
- }
- },
- "id": "AuthRequirement"
- },
- "Documentation": {
- "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- },
- "rules": {
- "items": {
- "$ref": "DocumentationRule"
- },
- "type": "array",
- "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
- },
- "pages": {
- "description": "The top level pages for the documentation set.",
- "items": {
- "$ref": "Page"
- },
- "type": "array"
- }
- },
- "id": "Documentation"
- },
- "BackendRule": {
- "properties": {
- "minDeadline": {
- "format": "double",
- "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
- "type": "number"
- },
- "address": {
- "description": "The address of the API backend.",
- "type": "string"
- },
- "selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
- },
- "deadline": {
- "format": "double",
- "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
- "type": "number"
- }
- },
- "id": "BackendRule",
- "description": "A backend rule provides configuration for an individual API element.",
- "type": "object"
- },
- "AuthenticationRule": {
- "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
- "type": "object",
- "properties": {
- "requirements": {
- "description": "Requirements for additional authentication providers.",
- "items": {
- "$ref": "AuthRequirement"
- },
- "type": "array"
- },
- "allowWithoutCredential": {
- "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
- "type": "boolean"
- },
- "selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
- },
- "customAuth": {
- "description": "Configuration for custom authentication.",
- "$ref": "CustomAuthRequirements"
- },
- "oauth": {
- "$ref": "OAuthRequirements",
- "description": "The requirements for OAuth credentials."
- }
- },
- "id": "AuthenticationRule"
- },
- "Api": {
- "id": "Api",
- "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
- "type": "string"
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "Source context for the protocol buffer service represented by this\nmessage."
- },
- "syntax": {
- "description": "The source syntax of the service.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ]
- },
- "version": {
- "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
- "type": "string"
- },
- "mixins": {
- "description": "Included interfaces. See Mixin.",
- "items": {
- "$ref": "Mixin"
- },
- "type": "array"
- },
- "options": {
- "description": "Any metadata attached to the interface.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
- },
- "methods": {
- "description": "The methods of this interface, in unspecified order.",
- "items": {
- "$ref": "Method"
- },
- "type": "array"
- }
- }
- },
- "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": {
- "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"
- },
- "selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
- }
- },
- "id": "MetricRule"
- },
- "Authentication": {
- "properties": {
- "providers": {
- "description": "Defines a set of authentication providers that a service supports.",
- "items": {
- "$ref": "AuthProvider"
- },
- "type": "array"
- },
- "rules": {
- "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "items": {
- "$ref": "AuthenticationRule"
- },
- "type": "array"
- }
- },
- "id": "Authentication",
- "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
- "type": "object"
- },
- "Operation": {
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- }
- },
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
- },
"Page": {
"description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"type": "object",
@@ -802,11 +13,11 @@
"type": "string"
},
"subpages": {
+ "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
"items": {
"$ref": "Page"
},
- "type": "array",
- "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset."
+ "type": "array"
}
},
"id": "Page"
@@ -816,6 +27,7 @@
"type": "object",
"properties": {
"details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"type": "object",
"additionalProperties": {
@@ -823,8 +35,7 @@
"type": "any"
}
},
- "type": "array",
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
+ "type": "array"
},
"code": {
"format": "int32",
@@ -832,73 +43,66 @@
"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"
},
"AuthProvider": {
+ "id": "AuthProvider",
"description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"type": "object",
"properties": {
+ "jwksUri": {
+ "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
+ "type": "string"
+ },
"audiences": {
"description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
"type": "string"
},
"authorizationUrl": {
- "type": "string",
- "description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec."
+ "description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec.",
+ "type": "string"
},
"issuer": {
- "type": "string",
- "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com"
+ "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com",
+ "type": "string"
},
"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"
+ }
+ }
+ },
+ "EnumValue": {
+ "description": "Enum value definition.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "format": "int32",
+ "description": "Enum value number.",
+ "type": "integer"
},
- "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",
+ "name": {
+ "description": "Enum value name.",
"type": "string"
+ },
+ "options": {
+ "description": "Protocol buffer options.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
}
},
- "id": "AuthProvider"
+ "id": "EnumValue"
},
"Service": {
"description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
"type": "object",
"properties": {
- "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.",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "type": "array"
- },
- "logging": {
- "$ref": "Logging",
- "description": "Logging configuration."
- },
- "enums": {
- "items": {
- "$ref": "Enum"
- },
- "type": "array",
- "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum"
- },
- "context": {
- "$ref": "Context",
- "description": "Context configuration."
- },
- "id": {
- "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
- "type": "string"
- },
"usage": {
"$ref": "Usage",
"description": "Configuration controlling usage of this service."
@@ -911,12 +115,12 @@
"type": "array"
},
"authentication": {
- "description": "Auth configuration.",
- "$ref": "Authentication"
+ "$ref": "Authentication",
+ "description": "Auth configuration."
},
"experimental": {
- "$ref": "Experimental",
- "description": "Experimental configuration."
+ "description": "Experimental configuration.",
+ "$ref": "Experimental"
},
"control": {
"$ref": "Control",
@@ -931,20 +135,20 @@
"$ref": "Monitoring",
"description": "Monitoring configuration."
},
- "systemTypes": {
- "items": {
- "$ref": "Type"
- },
- "type": "array",
- "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 Google project that owns this service.",
"type": "string"
},
+ "systemTypes": {
+ "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
+ "items": {
+ "$ref": "Type"
+ },
+ "type": "array"
+ },
"visibility": {
- "$ref": "Visibility",
- "description": "API visibility configuration."
+ "description": "API visibility configuration.",
+ "$ref": "Visibility"
},
"quota": {
"$ref": "Quota",
@@ -998,70 +202,56 @@
"$ref": "Http",
"description": "HTTP configuration."
},
+ "backend": {
+ "description": "API backend configuration.",
+ "$ref": "Backend"
+ },
"systemParameters": {
"$ref": "SystemParameters",
"description": "System parameter configuration."
},
- "backend": {
- "description": "API backend configuration.",
- "$ref": "Backend"
+ "documentation": {
+ "description": "Additional API documentation.",
+ "$ref": "Documentation"
+ },
+ "monitoredResources": {
+ "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "type": "array"
+ },
+ "logging": {
+ "$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",
+ "items": {
+ "$ref": "Enum"
+ },
+ "type": "array"
+ },
+ "context": {
+ "description": "Context configuration.",
+ "$ref": "Context"
+ },
+ "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."
}
},
"id": "Service"
},
- "EnumValue": {
- "description": "Enum value definition.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Enum value name.",
- "type": "string"
- },
- "options": {
- "items": {
- "$ref": "Option"
- },
- "type": "array",
- "description": "Protocol buffer options."
- },
- "number": {
- "format": "int32",
- "description": "Enum value number.",
- "type": "integer"
- }
- },
- "id": "EnumValue"
- },
- "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": {
- "description": "The metadata associated with a long running operation resource.",
"type": "object",
"properties": {
- "startTime": {
- "format": "google-datetime",
- "description": "The start time of the operation.",
- "type": "string"
- },
"steps": {
- "description": "Detailed status information for each step. The order is undetermined.",
"items": {
"$ref": "Step"
},
- "type": "array"
+ "type": "array",
+ "description": "Detailed status information for each step. The order is undetermined."
},
"resourceNames": {
"description": "The full name of the resources that this operation is directly\nassociated with.",
@@ -1071,45 +261,139 @@
"type": "array"
},
"progressPercentage": {
- "type": "integer",
"format": "int32",
- "description": "Percentage of completion of this operation, ranging from 0 to 100."
+ "description": "Percentage of completion of this operation, ranging from 0 to 100.",
+ "type": "integer"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start time of the operation.",
+ "type": "string"
}
},
- "id": "OperationMetadata"
+ "id": "OperationMetadata",
+ "description": "The metadata associated with a long running operation resource."
},
- "PublishedService": {
- "description": "The published version of a Service that is managed by\nGoogle Service Management.",
+ "CustomHttpPattern": {
+ "description": "A custom pattern is used for defining custom HTTP verb.",
"type": "object",
"properties": {
- "name": {
- "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
+ "path": {
+ "description": "The path matched by this custom verb.",
"type": "string"
},
- "service": {
- "$ref": "Service",
- "description": "The service's published configuration."
+ "kind": {
+ "description": "The name of this custom HTTP verb.",
+ "type": "string"
}
},
- "id": "PublishedService"
+ "id": "CustomHttpPattern"
},
"SystemParameterRule": {
- "id": "SystemParameterRule",
"description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
"type": "object",
"properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
"parameters": {
"description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
"items": {
"$ref": "SystemParameter"
},
"type": "array"
+ }
+ },
+ "id": "SystemParameterRule"
+ },
+ "PublishedService": {
+ "description": "The published version of a Service that is managed by\nGoogle Service Management.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "$ref": "Service",
+ "description": "The service's published configuration."
},
- "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.",
+ "name": {
+ "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
"type": "string"
}
- }
+ },
+ "id": "PublishedService"
+ },
+ "HttpRule": {
+ "properties": {
+ "body": {
+ "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
+ "type": "string"
+ },
+ "post": {
+ "description": "Used for creating a resource.",
+ "type": "string"
+ },
+ "mediaDownload": {
+ "$ref": "MediaDownload",
+ "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
+ },
+ "restMethodName": {
+ "description": "DO NOT USE. This is an experimental field.\n\nOptional. 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\n\"create\", but for backwards compatibility with apiary, it is specified as\ninsert.",
+ "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).",
+ "items": {
+ "$ref": "HttpRule"
+ },
+ "type": "array"
+ },
+ "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": "DO NOT USE. This is an experimental field.\n\nOptional. The REST collection name is by default derived from the URL\npattern. If specified, this field overrides the default collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggregatedListRequest)\n returns (AddressesAggregatedListResponse) {\n option (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/addresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\nThis method has the automatically derived collection name\n\"projects.aggregated\". Because, semantically, this rpc is actually an\noperation on the \"projects.addresses\" collection, the `rest_collection`\nfield is configured to override the derived collection name.",
+ "type": "string"
+ },
+ "mediaUpload": {
+ "$ref": "MediaUpload",
+ "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
+ },
+ "selector": {
+ "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "custom": {
+ "$ref": "CustomHttpPattern",
+ "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients."
+ },
+ "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"
+ },
+ "authorizations": {
+ "items": {
+ "$ref": "AuthorizationRule"
+ },
+ "type": "array",
+ "description": "Specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource."
+ },
+ "delete": {
+ "description": "Used for deleting a resource.",
+ "type": "string"
+ }
+ },
+ "id": "HttpRule",
+ "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
+ "type": "object"
},
"VisibilityRule": {
"description": "A visibility rule provides visibility configuration for an individual API\nelement.",
@@ -1126,81 +410,7 @@
},
"id": "VisibilityRule"
},
- "HttpRule": {
- "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "custom": {
- "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients.",
- "$ref": "CustomHttpPattern"
- },
- "get": {
- "description": "Used for listing and getting information about resources.",
- "type": "string"
- },
- "patch": {
- "type": "string",
- "description": "Used for updating a resource."
- },
- "authorizations": {
- "description": "Specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource.",
- "items": {
- "$ref": "AuthorizationRule"
- },
- "type": "array"
- },
- "put": {
- "description": "Used for updating a resource.",
- "type": "string"
- },
- "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"
- },
- "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": {
- "type": "string",
- "description": "DO NOT USE. This is an experimental field.\n\nOptional. 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\n\"create\", but for backwards compatibility with apiary, it is specified as\ninsert."
- },
- "additionalBindings": {
- "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
- "items": {
- "$ref": "HttpRule"
- },
- "type": "array"
- },
- "restCollection": {
- "description": "DO NOT USE. This is an experimental field.\n\nOptional. The REST collection name is by default derived from the URL\npattern. If specified, this field overrides the default collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggregatedListRequest)\n returns (AddressesAggregatedListResponse) {\n option (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/addresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\nThis method has the automatically derived collection name\n\"projects.aggregated\". Because, semantically, this rpc is actually an\noperation on the \"projects.addresses\" collection, the `rest_collection`\nfield is configured to override the derived collection name.",
- "type": "string"
- },
- "responseBody": {
- "type": "string",
- "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type."
- },
- "mediaUpload": {
- "$ref": "MediaUpload",
- "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
- }
- },
- "id": "HttpRule"
- },
"MonitoringDestination": {
- "id": "MonitoringDestination",
"description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
"type": "object",
"properties": {
@@ -1215,7 +425,8 @@
},
"type": "array"
}
- }
+ },
+ "id": "MonitoringDestination"
},
"Visibility": {
"description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
@@ -1232,8 +443,6 @@
"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.",
@@ -1243,7 +452,9 @@
"type": "array"
}
},
- "id": "SystemParameters"
+ "id": "SystemParameters",
+ "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
+ "type": "object"
},
"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",
@@ -1267,18 +478,8 @@
"id": "Quota"
},
"Step": {
- "description": "Represents the status of one operation step.",
- "type": "object",
"properties": {
"status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "DONE",
- "NOT_STARTED",
- "IN_PROGRESS",
- "FAILED",
- "CANCELLED"
- ],
"description": "The status code.",
"type": "string",
"enumDescriptions": [
@@ -1288,6 +489,14 @@
"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"
]
},
"description": {
@@ -1295,9 +504,13 @@
"type": "string"
}
},
- "id": "Step"
+ "id": "Step",
+ "description": "Represents the status of one operation step.",
+ "type": "object"
},
"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 \"/\".",
@@ -1311,78 +524,52 @@
"type": "string"
}
},
- "id": "LoggingDestination",
- "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
- "type": "object"
+ "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": {
+ "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
- "type": "object"
- },
- "name": {
- "type": "string",
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`."
+ }
}
},
- "id": "Option",
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
- "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": {
+ "producerDestinations": {
+ "items": {
+ "$ref": "LoggingDestination"
+ },
+ "type": "array",
+ "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."
+ },
"consumerDestinations": {
"description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
"items": {
"$ref": "LoggingDestination"
},
"type": "array"
- },
- "producerDestinations": {
- "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
- "items": {
- "$ref": "LoggingDestination"
- },
- "type": "array"
}
},
- "id": "Logging",
- "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history"
+ "id": "Logging"
},
"Method": {
"description": "Method represents a method of an API interface.",
"type": "object",
"properties": {
- "name": {
- "description": "The simple name of this method.",
- "type": "string"
- },
- "requestTypeUrl": {
- "type": "string",
- "description": "A URL of the input message type."
- },
- "requestStreaming": {
- "type": "boolean",
- "description": "If true, the request is streamed."
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax of this method.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- },
"responseTypeUrl": {
"description": "The URL of the output message type.",
"type": "string"
@@ -1397,33 +584,63 @@
"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": {
+ "type": "boolean",
+ "description": "If true, the request is streamed."
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of this method.",
+ "type": "string"
}
},
"id": "Method"
},
"QuotaLimit": {
+ "id": "QuotaLimit",
"description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
"type": "object",
"properties": {
- "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`).",
+ "defaultLimit": {
+ "format": "int64",
+ "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
"type": "string"
},
"displayName": {
"description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
"type": "string"
},
+ "description": {
+ "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
+ "type": "string"
+ },
+ "metric": {
+ "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
+ "type": "string"
+ },
"values": {
- "description": "Tiered limit values, currently only STANDARD is supported.",
- "type": "object",
"additionalProperties": {
"format": "int64",
"type": "string"
- }
+ },
+ "description": "Tiered limit values, currently only STANDARD is supported.",
+ "type": "object"
},
"unit": {
"description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
@@ -1435,8 +652,8 @@
"description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only."
},
"name": {
- "type": "string",
- "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit."
+ "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
+ "type": "string"
},
"duration": {
"description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
@@ -1446,16 +663,11 @@
"format": "int64",
"description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
"type": "string"
- },
- "defaultLimit": {
- "type": "string",
- "format": "int64",
- "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only."
}
- },
- "id": "QuotaLimit"
+ }
},
"Mixin": {
+ "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
"type": "object",
"properties": {
"name": {
@@ -1467,81 +679,85 @@
"type": "string"
}
},
- "id": "Mixin",
- "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }"
+ "id": "Mixin"
},
"CustomError": {
+ "id": "CustomError",
+ "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
"type": "object",
"properties": {
- "types": {
- "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"rules": {
"description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
"$ref": "CustomErrorRule"
},
"type": "array"
+ },
+ "types": {
+ "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
- },
- "id": "CustomError",
- "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError"
+ }
},
"Http": {
- "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
- "type": "object",
"properties": {
- "fullyDecodeReservedExpansion": {
- "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
- "type": "boolean"
- },
"rules": {
"description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
"$ref": "HttpRule"
},
"type": "array"
+ },
+ "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."
}
},
- "id": "Http"
+ "id": "Http",
+ "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
+ "type": "object"
},
"SourceInfo": {
"description": "Source information used to create a Service Config",
"type": "object",
"properties": {
"sourceFiles": {
- "description": "All files used during config generation.",
"items": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "type": "object"
},
- "type": "array"
+ "type": "array",
+ "description": "All files used during config generation."
}
},
"id": "SourceInfo"
},
"Control": {
- "id": "Control",
"description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
"type": "object",
"properties": {
"environment": {
- "type": "string",
- "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled."
+ "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
+ "type": "string"
}
- }
+ },
+ "id": "Control"
},
"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"
@@ -1549,50 +765,33 @@
"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": {
- "description": "A single field of a message type.",
+ "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": {
- "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"
- ],
- "description": "The field cardinality."
+ "consumerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
+ "items": {
+ "$ref": "MonitoringDestination"
+ },
+ "type": "array"
},
- "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"
- },
+ "producerDestinations": {
+ "items": {
+ "$ref": "MonitoringDestination"
+ },
+ "type": "array",
+ "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"
+ },
+ "Field": {
+ "type": "object",
+ "properties": {
"number": {
"format": "int32",
"description": "The field number.",
@@ -1659,34 +858,44 @@
"format": "int32",
"description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
"type": "integer"
- }
- },
- "id": "Field"
- },
- "Monitoring": {
- "properties": {
- "consumerDestinations": {
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "type": "array"
},
- "producerDestinations": {
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "type": "array"
+ "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"
}
},
- "id": "Monitoring",
- "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
- "type": "object"
+ "id": "Field",
+ "description": "A single field of a message type."
},
"Enum": {
- "description": "Enum type definition.",
- "type": "object",
"properties": {
"enumvalue": {
"description": "Enum value definitions.",
@@ -1719,13 +928,23 @@
"type": "string"
},
"sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
+ "description": "The source context.",
+ "$ref": "SourceContext"
}
},
- "id": "Enum"
+ "id": "Enum",
+ "description": "Enum type definition.",
+ "type": "object"
+ },
+ "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.",
@@ -1736,29 +955,21 @@
"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",
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ]
+ "type": "string"
}
},
- "id": "LabelDescriptor",
- "description": "A description of a label.",
- "type": "object"
- },
- "EnableServiceRequest": {
- "description": "Request message for EnableService method.",
- "type": "object",
- "properties": {},
- "id": "EnableServiceRequest"
+ "id": "LabelDescriptor"
},
"Type": {
"description": "A protocol buffer message type.",
@@ -1772,11 +983,11 @@
"type": "array"
},
"fields": {
- "description": "The list of fields.",
"items": {
"$ref": "Field"
},
- "type": "array"
+ "type": "array",
+ "description": "The list of fields."
},
"name": {
"description": "The fully qualified message name.",
@@ -1789,10 +1000,6 @@
},
"type": "array"
},
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
"syntax": {
"enumDescriptions": [
"Syntax `proto2`.",
@@ -1804,6 +1011,10 @@
],
"description": "The source syntax.",
"type": "string"
+ },
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
}
},
"id": "Type"
@@ -1833,26 +1044,8 @@
},
"id": "Backend"
},
- "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": {
@@ -1860,8 +1053,26 @@
"description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
"type": "string"
}
+ }
+ },
+ "DocumentationRule": {
+ "properties": {
+ "deprecationDescription": {
+ "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the selected API(s).",
+ "type": "string"
+ }
},
- "id": "AuthorizationConfig"
+ "id": "DocumentationRule",
+ "description": "A documentation rule provides information about individual API elements.",
+ "type": "object"
},
"ContextRule": {
"description": "A context rule provides information about the context for an individual API\nelement.",
@@ -1875,15 +1086,15 @@
"type": "array"
},
"requested": {
+ "description": "A list of full type names of requested contexts.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "A list of full type names of requested contexts."
+ "type": "array"
},
"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": "ContextRule"
@@ -1900,9 +1111,12 @@
"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": {
+ "type": "string",
+ "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": {
"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"
@@ -1930,6 +1144,12 @@
]
},
"metricKind": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
+ ],
"enum": [
"METRIC_KIND_UNSPECIFIED",
"GAUGE",
@@ -1937,13 +1157,7 @@
"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."
- ]
+ "type": "string"
},
"description": {
"description": "A detailed description of the metric, which can be used in documentation.",
@@ -1963,20 +1177,570 @@
"$ref": "LabelDescriptor"
},
"type": "array"
+ }
+ },
+ "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."
+ },
+ "ListEnabledServicesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
+ "type": "string"
+ },
+ "services": {
+ "description": "Services enabled for the specified parent.",
+ "items": {
+ "$ref": "PublishedService"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListEnabledServicesResponse",
+ "description": "Response message for `ListEnabledServices` method.",
+ "type": "object"
+ },
+ "Endpoint": {
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
+ "type": "object",
+ "properties": {
+ "features": {
+ "description": "The list of features enabled on this endpoint.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "apis": {
+ "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "aliases": {
+ "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "allowCors": {
+ "type": "boolean",
+ "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed."
},
"name": {
- "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\"",
+ "description": "The canonical name of this endpoint.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
"type": "string"
}
},
- "id": "MetricDescriptor"
+ "id": "Endpoint"
+ },
+ "OAuthRequirements": {
+ "id": "OAuthRequirements",
+ "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
+ "type": "object",
+ "properties": {
+ "canonicalScopes": {
+ "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
+ "type": "string"
+ }
+ }
+ },
+ "Usage": {
+ "properties": {
+ "producerNotificationChannel": {
+ "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "items": {
+ "$ref": "UsageRule"
+ },
+ "type": "array"
+ },
+ "requirements": {
+ "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Usage",
+ "description": "Configuration controlling usage of a service.",
+ "type": "object"
+ },
+ "Context": {
+ "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "items": {
+ "$ref": "ContextRule"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Context"
+ },
+ "LogDescriptor": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
+ "type": "string"
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise."
+ },
+ "description": {
+ "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ }
+ },
+ "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"
+ },
+ "CustomErrorRule": {
+ "type": "object",
+ "properties": {
+ "isErrorType": {
+ "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
+ "type": "boolean"
+ },
+ "selector": {
+ "type": "string",
+ "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details."
+ }
+ },
+ "id": "CustomErrorRule",
+ "description": "A custom error rule."
+ },
+ "MonitoredResourceDescriptor": {
+ "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
+ "type": "string"
+ }
+ },
+ "id": "MonitoredResourceDescriptor"
+ },
+ "MediaDownload": {
+ "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": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ },
+ "maxDirectDownloadSize": {
+ "format": "int64",
+ "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
+ "type": "string"
+ },
+ "useDirectDownload": {
+ "type": "boolean",
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media."
+ }
+ },
+ "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."
+ },
+ "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"
+ },
+ "DisableServiceRequest": {
+ "description": "Request message for DisableService method.",
+ "type": "object",
+ "properties": {},
+ "id": "DisableServiceRequest"
+ },
+ "AuthorizationRule": {
+ "properties": {
+ "selector": {
+ "description": "Selects the API elements to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "permissions": {
+ "description": "The required permissions. The acceptable values vary depend on the\nauthorization system used. For Google APIs, it should be a comma-separated\nGoogle IAM permission values. When multiple permissions are listed, the\nsemantics is not defined by the system. Additional documentation must\nbe provided manually.",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizationRule",
+ "description": "Authorization rule for API services.\n\nIt specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource.\n\nFor example:\n\n package google.storage.v1;\n\n message CopyObjectRequest {\n string source = 1 [\n (google.api.authz).permissions = \"storage.objects.get\"];\n\n string destination = 2 [\n (google.api.authz).permissions =\n \"storage.objects.create,storage.objects.update\"];\n }",
+ "type": "object"
+ },
+ "SearchServicesResponse": {
+ "description": "Response message for SearchServices method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
+ "type": "string"
+ },
+ "services": {
+ "description": "Services available publicly or available to the authenticated caller.",
+ "items": {
+ "$ref": "PublishedService"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SearchServicesResponse"
+ },
+ "MediaUpload": {
+ "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "type": "string",
+ "description": "Name of the Scotty dropzone to use for the current API."
+ },
+ "startNotification": {
+ "description": "Whether to receive a notification on the start of media upload.",
+ "type": "boolean"
+ },
+ "uploadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
+ "type": "string"
+ },
+ "maxSize": {
+ "format": "int64",
+ "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
+ "type": "string"
+ },
+ "mimeTypes": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns."
+ }
+ },
+ "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"
+ },
+ "skipServiceControl": {
+ "description": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.",
+ "type": "boolean"
+ },
+ "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": {
+ "audiences": {
+ "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
+ "type": "string"
+ },
+ "providerId": {
+ "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
+ "type": "string"
+ }
+ },
+ "id": "AuthRequirement"
+ },
+ "Documentation": {
+ "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"
+ },
+ "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."
+ },
+ "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.",
+ "items": {
+ "$ref": "DocumentationRule"
+ },
+ "type": "array"
+ },
+ "pages": {
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array",
+ "description": "The top level pages for the documentation set."
+ }
+ },
+ "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"
+ },
+ "BackendRule": {
+ "type": "object",
+ "properties": {
+ "minDeadline": {
+ "type": "number",
+ "format": "double",
+ "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected."
+ },
+ "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": {
+ "format": "double",
+ "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
+ "type": "number"
+ }
+ },
+ "id": "BackendRule",
+ "description": "A backend rule provides configuration for an individual API element."
+ },
+ "AuthenticationRule": {
+ "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
+ "type": "object",
+ "properties": {
+ "customAuth": {
+ "$ref": "CustomAuthRequirements",
+ "description": "Configuration for custom authentication."
+ },
+ "oauth": {
+ "description": "The requirements for OAuth credentials.",
+ "$ref": "OAuthRequirements"
+ },
+ "requirements": {
+ "description": "Requirements for additional authentication providers.",
+ "items": {
+ "$ref": "AuthRequirement"
+ },
+ "type": "array"
+ },
+ "allowWithoutCredential": {
+ "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
+ "type": "boolean"
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "AuthenticationRule"
+ },
+ "Api": {
+ "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
+ "type": "object",
+ "properties": {
+ "mixins": {
+ "description": "Included interfaces. See Mixin.",
+ "items": {
+ "$ref": "Mixin"
+ },
+ "type": "array"
+ },
+ "options": {
+ "description": "Any metadata attached to the interface.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
+ },
+ "methods": {
+ "description": "The methods of this interface, in unspecified order.",
+ "items": {
+ "$ref": "Method"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "description": "Source context for the protocol buffer service represented by this\nmessage.",
+ "$ref": "SourceContext"
+ },
+ "syntax": {
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of the service.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ]
+ },
+ "version": {
+ "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
+ "type": "string"
+ }
+ },
+ "id": "Api"
+ },
+ "MetricRule": {
+ "id": "MetricRule",
+ "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ }
+ },
+ "Authentication": {
+ "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "items": {
+ "$ref": "AuthenticationRule"
+ },
+ "type": "array"
+ },
+ "providers": {
+ "description": "Defines a set of authentication providers that a service supports.",
+ "items": {
+ "$ref": "AuthProvider"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Authentication"
+ },
+ "Operation": {
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "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"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Service User",
"auth": {
"oauth2": {
@@ -1998,5 +1762,241 @@
"name": "serviceuser",
"batchPath": "batch",
"title": "Google Service User API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "services": {
+ "methods": {
+ "disable": {
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/services/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable",
+ "id": "serviceuser.projects.services.disable",
+ "path": "v1/{+name}:disable"
+ },
+ "enable": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:enable",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/services/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable",
+ "path": "v1/{+name}:enable",
+ "id": "serviceuser.projects.services.enable",
+ "description": "Enable a service so it can be used with a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
+ "request": {
+ "$ref": "EnableServiceRequest"
+ }
+ },
+ "list": {
+ "description": "List enabled services for the specified consumer.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListEnabledServicesResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Requested size of the next page of data."
+ },
+ "parent": {
+ "location": "path",
+ "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/services",
+ "path": "v1/{+parent}/services",
+ "id": "serviceuser.projects.services.list"
+ }
+ }
+ }
+ }
+ },
+ "services": {
+ "methods": {
+ "search": {
+ "flatPath": "v1/services:search",
+ "path": "v1/services:search",
+ "id": "serviceuser.services.search",
+ "description": "Search available services.\n\nWhen no filter is specified, returns all accessible services. For\nauthenticated users, also returns all services the calling user has\n\"servicemanagement.services.bind\" permission for.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchServicesResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested size of the next page of data.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ }
+ },
+ "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": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://serviceuser.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "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.",
+ "basePath": "",
+ "revision": "20170819",
+ "documentationLink": "https://cloud.google.com/service-management/",
+ "id": "serviceuser:v1",
+ "discoveryVersion": "v1",
+ "version_module": true
}
diff --git a/sheets/v4/sheets-api.json b/sheets/v4/sheets-api.json
index 24c4fe8..68f754d 100644
--- a/sheets/v4/sheets-api.json
+++ b/sheets/v4/sheets-api.json
@@ -1,535 +1,687 @@
{
- "documentationLink": "https://developers.google.com/sheets/",
+ "canonicalName": "Sheets",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/drive.file": {
+ "description": "View and manage Google Drive files and folders that you have opened or created with this app"
+ },
+ "https://www.googleapis.com/auth/spreadsheets.readonly": {
+ "description": "View your Google Spreadsheets"
+ },
+ "https://www.googleapis.com/auth/drive.readonly": {
+ "description": "View the files in your Google Drive"
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://sheets.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "sheets",
+ "batchPath": "batch",
+ "title": "Google Sheets API",
+ "ownerName": "Google",
+ "resources": {
+ "spreadsheets": {
+ "methods": {
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "parameters": {
+ "includeGridData": {
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "ranges": {
+ "repeated": true,
+ "location": "query",
+ "description": "The ranges to retrieve from the spreadsheet.",
+ "type": "string"
+ },
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}",
+ "path": "v4/spreadsheets/{spreadsheetId}",
+ "id": "sheets.spreadsheets.get",
+ "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation."
+ },
+ "batchUpdate": {
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchUpdateSpreadsheetResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to apply the updates to.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "create": {
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {},
+ "flatPath": "v4/spreadsheets",
+ "id": "sheets.spreadsheets.create",
+ "path": "v4/spreadsheets",
+ "request": {
+ "$ref": "Spreadsheet"
+ },
+ "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST"
+ }
+ },
+ "resources": {
+ "sheets": {
+ "methods": {
+ "copyTo": {
+ "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
+ "request": {
+ "$ref": "CopySheetToAnotherSpreadsheetRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId",
+ "sheetId"
+ ],
+ "response": {
+ "$ref": "SheetProperties"
+ },
+ "parameters": {
+ "sheetId": {
+ "type": "integer",
+ "required": true,
+ "location": "path",
+ "format": "int32",
+ "description": "The ID of the sheet to copy."
+ },
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet containing the sheet to copy.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
+ "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
+ "id": "sheets.spreadsheets.sheets.copyTo"
+ }
+ }
+ },
+ "values": {
+ "methods": {
+ "update": {
+ "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
+ "request": {
+ "$ref": "ValueRange"
+ },
+ "response": {
+ "$ref": "UpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "range": {
+ "description": "The A1 notation of the values to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "includeValuesInResponse": {
+ "location": "query",
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
+ "type": "boolean"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "responseValueRenderOption": {
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE."
+ },
+ "valueInputOption": {
+ "location": "query",
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ],
+ "description": "How the input data should be interpreted.",
+ "type": "string"
+ },
+ "responseDateTimeRenderOption": {
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ]
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.update",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}"
+ },
+ "batchUpdate": {
+ "response": {
+ "$ref": "BatchUpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "id": "sheets.spreadsheets.values.batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}/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"
+ }
+ },
+ "batchGet": {
+ "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
+ "response": {
+ "$ref": "BatchGetValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "ranges": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "description": "The A1 notation of the values to retrieve."
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "dateTimeRenderOption": {
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ },
+ "valueRenderOption": {
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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"
+ },
+ "clear": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "response": {
+ "$ref": "ClearValuesResponse"
+ },
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "range": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The A1 notation of the values to clear."
+ }
+ },
+ "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",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "id": "sheets.spreadsheets.values.clear",
+ "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
+ "request": {
+ "$ref": "ClearValuesRequest"
+ }
+ },
+ "append": {
+ "parameters": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "OVERWRITE",
+ "INSERT_ROWS"
+ ],
+ "description": "How the input data should be inserted."
+ },
+ "valueInputOption": {
+ "location": "query",
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ],
+ "description": "How the input data should be interpreted.",
+ "type": "string"
+ },
+ "responseDateTimeRenderOption": {
+ "type": "string",
+ "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]."
+ },
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "range": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table."
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
+ "id": "sheets.spreadsheets.values.append",
+ "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.",
+ "request": {
+ "$ref": "ValueRange"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "response": {
+ "$ref": "AppendValuesResponse"
+ }
+ },
+ "batchClear": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchClearValuesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
+ "id": "sheets.spreadsheets.values.batchClear",
+ "request": {
+ "$ref": "BatchClearValuesRequest"
+ },
+ "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept."
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "parameters": {
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of the values to retrieve.",
+ "type": "string",
+ "required": true
+ },
+ "dateTimeRenderOption": {
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ },
+ "valueRenderOption": {
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ]
+ },
+ "majorDimension": {
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`."
+ },
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.get",
+ "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "response": {
+ "$ref": "ValueRange"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "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"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response."
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "version": "v4",
+ "baseUrl": "https://sheets.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Reads and writes Google Sheets.",
+ "servicePath": "",
+ "basePath": "",
"revision": "20170822",
+ "documentationLink": "https://developers.google.com/sheets/",
"id": "sheets:v4",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "DeleteFilterViewRequest": {
- "description": "Deletes a particular filter view.",
+ "OrgChartSpec": {
+ "id": "OrgChartSpec",
+ "description": "An \u003ca href=\"/chart/interactive/docs/gallery/orgchart\"\u003eorg chart\u003c/a\u003e.\nOrg charts require a unique set of labels in labels and may\noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also reporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"President\", \"VP Sales\".",
"type": "object",
"properties": {
- "filterId": {
- "format": "int32",
- "description": "The ID of the filter to delete.",
- "type": "integer"
- }
- },
- "id": "DeleteFilterViewRequest"
- },
- "BatchUpdateValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "totalUpdatedSheets": {
- "format": "int32",
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
- "type": "integer"
- },
- "totalUpdatedCells": {
- "format": "int32",
- "description": "The total number of cells updated.",
- "type": "integer"
- },
- "totalUpdatedColumns": {
- "format": "int32",
- "description": "The total number of columns where at least one cell in the column was\nupdated.",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "totalUpdatedRows": {
- "format": "int32",
- "description": "The total number of rows where at least one cell in the row was updated.",
- "type": "integer"
- },
- "responses": {
- "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared.",
- "items": {
- "$ref": "UpdateValuesResponse"
- },
- "type": "array"
- }
- },
- "id": "BatchUpdateValuesResponse"
- },
- "SortRangeRequest": {
- "id": "SortRangeRequest",
- "description": "Sorts data in rows based on a sort order per column.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The range to sort.",
- "$ref": "GridRange"
- },
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
- "items": {
- "$ref": "SortSpec"
- },
- "type": "array"
- }
- }
- },
- "MergeCellsRequest": {
- "id": "MergeCellsRequest",
- "description": "Merges all cells in the range.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range of cells to merge."
- },
- "mergeType": {
- "enumDescriptions": [
- "Create a single merge from the range",
- "Create a merge for each column in the range",
- "Create a merge for each row in the range"
- ],
- "enum": [
- "MERGE_ALL",
- "MERGE_COLUMNS",
- "MERGE_ROWS"
- ],
- "description": "How the cells should be merged.",
- "type": "string"
- }
- }
- },
- "AddProtectedRangeRequest": {
- "description": "Adds a new protected range.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)",
- "$ref": "ProtectedRange"
- }
- },
- "id": "AddProtectedRangeRequest"
- },
- "BatchClearValuesRequest": {
- "id": "BatchClearValuesRequest",
- "description": "The request for clearing more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "ranges": {
- "description": "The ranges to clear, in A1 notation.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "DuplicateFilterViewResponse": {
- "description": "The result of a filter view being duplicated.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "The newly created filter.",
- "$ref": "FilterView"
- }
- },
- "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": {
- "description": "Clears the basic filter, if any exists on the sheet.",
- "type": "object",
- "properties": {
- "sheetId": {
- "format": "int32",
- "description": "The sheet ID on which the basic filter should be cleared.",
- "type": "integer"
- }
- },
- "id": "ClearBasicFilterRequest"
- },
- "TextToColumnsRequest": {
- "id": "TextToColumnsRequest",
- "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
- "type": "object",
- "properties": {
- "delimiterType": {
- "description": "The delimiter type to use.",
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "\",\"",
- "\";\"",
- "\".\"",
- "\" \"",
- "A custom value as defined in delimiter."
- ],
- "enum": [
- "DELIMITER_TYPE_UNSPECIFIED",
- "COMMA",
- "SEMICOLON",
- "PERIOD",
- "SPACE",
- "CUSTOM"
- ]
- },
- "source": {
- "description": "The source data range. This must span exactly one column.",
- "$ref": "GridRange"
- },
- "delimiter": {
- "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
- "type": "string"
- }
- }
- },
- "DeleteBandingRequest": {
- "description": "Removes the banded range with the given ID from the spreadsheet.",
- "type": "object",
- "properties": {
- "bandedRangeId": {
- "format": "int32",
- "description": "The ID of the banded range to delete.",
- "type": "integer"
- }
- },
- "id": "DeleteBandingRequest"
- },
- "BatchUpdateSpreadsheetResponse": {
- "description": "The reply for batch updating a spreadsheet.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "updatedSpreadsheet": {
- "$ref": "Spreadsheet",
- "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
- },
- "replies": {
- "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
- "items": {
- "$ref": "Response"
- },
- "type": "array"
- }
- },
- "id": "BatchUpdateSpreadsheetResponse"
- },
- "AppendValuesResponse": {
- "id": "AppendValuesResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "updates": {
- "$ref": "UpdateValuesResponse",
- "description": "Information about the updates that were applied."
- },
- "tableRange": {
- "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.",
- "type": "string"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- }
- },
- "MoveDimensionRequest": {
- "id": "MoveDimensionRequest",
- "description": "Moves one or more rows or columns.",
- "type": "object",
- "properties": {
- "destinationIndex": {
- "format": "int32",
- "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
- "type": "integer"
- },
- "source": {
- "$ref": "DimensionRange",
- "description": "The source dimensions to move."
- }
- }
- },
- "PivotFilterCriteria": {
- "description": "Criteria for showing/hiding rows in a pivot table.",
- "type": "object",
- "properties": {
- "visibleValues": {
- "description": "Values that should be included. Values not listed here are excluded.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "PivotFilterCriteria"
- },
- "AddFilterViewRequest": {
- "id": "AddFilterViewRequest",
- "description": "Adds a filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)",
- "$ref": "FilterView"
- }
- }
- },
- "AddConditionalFormatRuleRequest": {
- "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
- "type": "object",
- "properties": {
- "rule": {
- "description": "The rule to add.",
- "$ref": "ConditionalFormatRule"
- },
- "index": {
- "format": "int32",
- "description": "The zero-based index where the rule should be inserted.",
- "type": "integer"
- }
- },
- "id": "AddConditionalFormatRuleRequest"
- },
- "ChartSpec": {
- "id": "ChartSpec",
- "description": "The specifications of a chart.",
- "type": "object",
- "properties": {
- "candlestickChart": {
- "$ref": "CandlestickChartSpec",
- "description": "A candlestick chart specification."
- },
- "bubbleChart": {
- "$ref": "BubbleChartSpec",
- "description": "A bubble chart specification."
- },
- "fontName": {
- "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.",
- "type": "string"
- },
- "maximized": {
- "description": "True to make a chart fill the entire space in which it's rendered with\nminimum padding. False to use the default padding.\n(Not applicable to Geo and Org charts.)",
- "type": "boolean"
- },
- "hiddenDimensionStrategy": {
- "description": "Determines how the charts will use hidden rows or columns.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "Charts will skip hidden rows and columns.",
- "Charts will skip hidden rows only.",
- "Charts will skip hidden columns only.",
- "Charts will not skip any hidden rows or columns."
- ],
- "enum": [
- "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
- "SKIP_HIDDEN_ROWS_AND_COLUMNS",
- "SKIP_HIDDEN_ROWS",
- "SKIP_HIDDEN_COLUMNS",
- "SHOW_ALL"
- ]
- },
- "backgroundColor": {
+ "selectedNodeColor": {
"$ref": "Color",
- "description": "The background color of the entire chart.\nNot applicable to Org charts."
+ "description": "The color of the selected org chart nodes."
},
- "basicChart": {
- "$ref": "BasicChartSpec",
- "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports."
- },
- "orgChart": {
- "$ref": "OrgChartSpec",
- "description": "An org chart specification."
- },
- "pieChart": {
- "$ref": "PieChartSpec",
- "description": "A pie chart specification."
- },
- "titleTextFormat": {
- "$ref": "TextFormat",
- "description": "The title text format.\nStrikethrough and underline are not supported."
- },
- "title": {
- "description": "The title of the chart.",
- "type": "string"
- },
- "altText": {
- "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
- "type": "string"
- },
- "histogramChart": {
- "$ref": "HistogramChartSpec",
- "description": "A histogram chart specification."
- }
- }
- },
- "NumberFormat": {
- "description": "The number format of a cell.",
- "type": "object",
- "properties": {
- "pattern": {
- "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for more\ninformation about the supported patterns.",
- "type": "string"
- },
- "type": {
- "description": "The type of the number format.\nWhen writing, this field must be set.",
- "type": "string",
- "enumDescriptions": [
- "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
- "Text formatting, e.g `1000.12`",
- "Number formatting, e.g, `1,000.12`",
- "Percent formatting, e.g `10.12%`",
- "Currency formatting, e.g `$1,000.12`",
- "Date formatting, e.g `9/26/2008`",
- "Time formatting, e.g `3:59:00 PM`",
- "Date+Time formatting, e.g `9/26/08 15:59:00`",
- "Scientific number formatting, e.g `1.01E+03`"
- ],
- "enum": [
- "NUMBER_FORMAT_TYPE_UNSPECIFIED",
- "TEXT",
- "NUMBER",
- "PERCENT",
- "CURRENCY",
- "DATE",
- "TIME",
- "DATE_TIME",
- "SCIENTIFIC"
- ]
- }
- },
- "id": "NumberFormat"
- },
- "CandlestickDomain": {
- "description": "The domain of a CandlestickChart.",
- "type": "object",
- "properties": {
- "data": {
+ "parentLabels": {
"$ref": "ChartData",
- "description": "The data of the CandlestickDomain."
+ "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional."
},
- "reversed": {
- "description": "True to reverse the order of the domain values (horizontal axis).",
- "type": "boolean"
- }
- },
- "id": "CandlestickDomain"
- },
- "SheetProperties": {
- "id": "SheetProperties",
- "description": "Properties of a sheet.",
- "type": "object",
- "properties": {
- "title": {
- "description": "The name of the sheet.",
- "type": "string"
+ "labels": {
+ "$ref": "ChartData",
+ "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique."
},
- "tabColor": {
- "$ref": "Color",
- "description": "The color of the tab in the UI."
- },
- "index": {
- "format": "int32",
- "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
- "type": "integer"
- },
- "sheetId": {
- "format": "int32",
- "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
- "type": "integer"
- },
- "rightToLeft": {
- "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
- "type": "boolean"
- },
- "hidden": {
- "description": "True if the sheet is hidden in the UI, false if it's visible.",
- "type": "boolean"
- },
- "sheetType": {
+ "nodeSize": {
+ "type": "string",
"enumDescriptions": [
"Default value, do not use.",
- "The sheet is a grid.",
- "The sheet has no grid and instead has an object like a chart or image."
+ "The small org chart node size.",
+ "The medium org chart node size.",
+ "The large org chart node size."
],
"enum": [
- "SHEET_TYPE_UNSPECIFIED",
- "GRID",
- "OBJECT"
+ "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
+ "SMALL",
+ "MEDIUM",
+ "LARGE"
],
- "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
- "type": "string"
+ "description": "The size of the org chart nodes."
},
- "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"
- }
- }
- },
- "UpdateDimensionPropertiesRequest": {
- "description": "Updates properties of dimensions within the specified range.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The rows or columns to update.",
- "$ref": "DimensionRange"
+ "nodeColor": {
+ "$ref": "Color",
+ "description": "The color of the org chart nodes."
},
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "type": "string"
- },
- "properties": {
- "$ref": "DimensionProperties",
- "description": "Properties to update."
- }
- },
- "id": "UpdateDimensionPropertiesRequest"
- },
- "SourceAndDestination": {
- "id": "SourceAndDestination",
- "description": "A combination of a source range and how to extend that source.",
- "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 that data should be filled into.",
- "type": "string"
- },
- "fillLength": {
- "format": "int32",
- "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
- "type": "integer"
- },
- "source": {
- "description": "The location of the data to use as the source of the autofill.",
- "$ref": "GridRange"
+ "tooltips": {
+ "$ref": "ChartData",
+ "description": "The data containing the tooltip for the corresponding node. A blank value\nresults in no tooltip being displayed for the node.\nThis field is optional."
}
}
},
"FilterView": {
- "description": "A filter view.",
"type": "object",
"properties": {
"filterViewId": {
@@ -549,8 +701,8 @@
"type": "string"
},
"range": {
- "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "$ref": "GridRange"
+ "$ref": "GridRange",
+ "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
},
"sortSpecs": {
"description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
@@ -564,73 +716,67 @@
"type": "string"
}
},
- "id": "FilterView"
- },
- "OrgChartSpec": {
- "description": "An \u003ca href=\"/chart/interactive/docs/gallery/orgchart\"\u003eorg chart\u003c/a\u003e.\nOrg charts require a unique set of labels in labels and may\noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also reporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"President\", \"VP Sales\".",
- "type": "object",
- "properties": {
- "tooltips": {
- "$ref": "ChartData",
- "description": "The data containing the tooltip for the corresponding node. A blank value\nresults in no tooltip being displayed for the node.\nThis field is optional."
- },
- "selectedNodeColor": {
- "description": "The color of the selected org chart nodes.",
- "$ref": "Color"
- },
- "parentLabels": {
- "$ref": "ChartData",
- "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional."
- },
- "labels": {
- "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique.",
- "$ref": "ChartData"
- },
- "nodeSize": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The small org chart node size.",
- "The medium org chart node size.",
- "The large org chart node size."
- ],
- "enum": [
- "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
- "SMALL",
- "MEDIUM",
- "LARGE"
- ],
- "description": "The size of the org chart nodes.",
- "type": "string"
- },
- "nodeColor": {
- "$ref": "Color",
- "description": "The color of the org chart nodes."
- }
- },
- "id": "OrgChartSpec"
+ "id": "FilterView",
+ "description": "A filter view."
},
"BandingProperties": {
- "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
"type": "object",
"properties": {
+ "footerColor": {
+ "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn.",
+ "$ref": "Color"
+ },
"headerColor": {
"$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."
},
"firstBandColor": {
- "$ref": "Color",
- "description": "The first color that is alternating. (Required)"
+ "description": "The first color that is alternating. (Required)",
+ "$ref": "Color"
},
"secondBandColor": {
"description": "The second color that is alternating. (Required)",
"$ref": "Color"
- },
- "footerColor": {
- "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn.",
- "$ref": "Color"
}
},
- "id": "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."
+ },
+ "CandlestickSeries": {
+ "id": "CandlestickSeries",
+ "description": "The series of a CandlestickData.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the CandlestickSeries."
+ }
+ }
+ },
+ "BasicFilter": {
+ "description": "The default filter associated with a sheet.",
+ "type": "object",
+ "properties": {
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "items": {
+ "$ref": "SortSpec"
+ },
+ "type": "array"
+ },
+ "criteria": {
+ "additionalProperties": {
+ "$ref": "FilterCriteria"
+ },
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
+ "type": "object"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range the filter covers."
+ }
+ },
+ "id": "BasicFilter"
},
"AddProtectedRangeResponse": {
"description": "The result of adding a new protected range.",
@@ -643,51 +789,10 @@
},
"id": "AddProtectedRangeResponse"
},
- "BasicFilter": {
- "id": "BasicFilter",
- "description": "The default filter associated with a sheet.",
- "type": "object",
- "properties": {
- "criteria": {
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
- "type": "object",
- "additionalProperties": {
- "$ref": "FilterCriteria"
- }
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range the filter covers."
- },
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
- "items": {
- "$ref": "SortSpec"
- },
- "type": "array"
- }
- }
- },
- "CandlestickSeries": {
- "description": "The series of a CandlestickData.",
- "type": "object",
- "properties": {
- "data": {
- "description": "The data of the CandlestickSeries.",
- "$ref": "ChartData"
- }
- },
- "id": "CandlestickSeries"
- },
"HistogramChartSpec": {
"description": "A \u003ca href=\"/chart/interactive/docs/gallery/histogram\"\u003ehistogram chart\u003c/a\u003e.\nA histogram chart groups data items into bins, displaying each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\nexplicitly.",
"type": "object",
"properties": {
- "outlierPercentile": {
- "format": "double",
- "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.",
- "type": "number"
- },
"showItemDividers": {
"description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
"type": "boolean"
@@ -725,6 +830,11 @@
"format": "double",
"description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
"type": "number"
+ },
+ "outlierPercentile": {
+ "format": "double",
+ "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.",
+ "type": "number"
}
},
"id": "HistogramChartSpec"
@@ -753,8 +863,8 @@
"type": "integer"
},
"updatedData": {
- "$ref": "ValueRange",
- "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`."
+ "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": {
"format": "int32",
@@ -764,16 +874,24 @@
}
},
"PivotValue": {
+ "id": "PivotValue",
"description": "The definition of how a value in a pivot table should be calculated.",
"type": "object",
"properties": {
+ "sourceColumnOffset": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`."
+ },
+ "name": {
+ "type": "string",
+ "description": "A name to use for the value. This is only used if formula was set.\nOtherwise, the column name is used."
+ },
"formula": {
"description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
"type": "string"
},
"summarizeFunction": {
- "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.",
- "type": "string",
"enumDescriptions": [
"The default, do not use.",
"Corresponds to the `SUM` function.",
@@ -807,28 +925,17 @@
"VAR",
"VARP",
"CUSTOM"
- ]
- },
- "sourceColumnOffset": {
- "format": "int32",
- "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
- "type": "integer"
- },
- "name": {
- "description": "A name to use for the value. This is only used if formula was set.\nOtherwise, the column name is used.",
+ ],
+ "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"
}
- },
- "id": "PivotValue"
+ }
},
"ErrorValue": {
+ "id": "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": {
"enumDescriptions": [
"The default error type, do not use this.",
@@ -856,9 +963,12 @@
],
"description": "The type of error.",
"type": "string"
+ },
+ "message": {
+ "description": "A message with more information about the error\n(in the spreadsheet's locale).",
+ "type": "string"
}
- },
- "id": "ErrorValue"
+ }
},
"CopySheetToAnotherSpreadsheetRequest": {
"id": "CopySheetToAnotherSpreadsheetRequest",
@@ -872,7 +982,6 @@
}
},
"PivotGroupSortValueBucket": {
- "id": "PivotGroupSortValueBucket",
"description": "Information about which values in a pivot group should be used for sorting.",
"type": "object",
"properties": {
@@ -888,9 +997,11 @@
"description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
"type": "integer"
}
- }
+ },
+ "id": "PivotGroupSortValueBucket"
},
"CandlestickChartSpec": {
+ "id": "CandlestickChartSpec",
"description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick chart\u003c/a\u003e.",
"type": "object",
"properties": {
@@ -905,11 +1016,9 @@
"$ref": "CandlestickDomain",
"description": "The domain data (horizontal axis) for the candlestick chart. String data\nwill be treated as discrete labels, other data will be treated as\ncontinuous values."
}
- },
- "id": "CandlestickChartSpec"
+ }
},
"CandlestickData": {
- "id": "CandlestickData",
"description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
"type": "object",
"properties": {
@@ -918,8 +1027,8 @@
"$ref": "CandlestickSeries"
},
"lowSeries": {
- "description": "The range data (vertical axis) for the low/minimum value for each candle.\nThis is the bottom of the candle's center line.",
- "$ref": "CandlestickSeries"
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the low/minimum value for each candle.\nThis is the bottom of the candle's center line."
},
"openSeries": {
"$ref": "CandlestickSeries",
@@ -929,30 +1038,30 @@
"description": "The range data (vertical axis) for the high/maximum value for each\ncandle. This is the top of the candle's center line.",
"$ref": "CandlestickSeries"
}
- }
+ },
+ "id": "CandlestickData"
},
"EmbeddedObjectPosition": {
"description": "The position of an embedded object such as a chart.",
"type": "object",
"properties": {
+ "newSheet": {
+ "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
+ "type": "boolean"
+ },
"overlayPosition": {
- "$ref": "OverlayPosition",
- "description": "The position at which the object is overlaid on top of a grid."
+ "description": "The position at which the object is overlaid on top of a grid.",
+ "$ref": "OverlayPosition"
},
"sheetId": {
"format": "int32",
"description": "The sheet this is on. Set only if the embedded object\nis on its own sheet. Must be non-negative.",
"type": "integer"
- },
- "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"
},
"DeleteProtectedRangeRequest": {
- "id": "DeleteProtectedRangeRequest",
"description": "Deletes the protected range with the given ID.",
"type": "object",
"properties": {
@@ -961,7 +1070,8 @@
"description": "The ID of the protected range to delete.",
"type": "integer"
}
- }
+ },
+ "id": "DeleteProtectedRangeRequest"
},
"AutoFillRequest": {
"description": "Fills in more data based on existing data.",
@@ -972,8 +1082,8 @@
"$ref": "GridRange"
},
"useAlternateSeries": {
- "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data."
},
"sourceAndDestination": {
"$ref": "SourceAndDestination",
@@ -986,52 +1096,47 @@
"description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
"type": "object",
"properties": {
- "midpoint": {
- "description": "An optional midway interpolation point.",
- "$ref": "InterpolationPoint"
- },
"maxpoint": {
- "description": "The final interpolation point.",
- "$ref": "InterpolationPoint"
+ "$ref": "InterpolationPoint",
+ "description": "The final interpolation point."
},
"minpoint": {
"description": "The starting interpolation point.",
"$ref": "InterpolationPoint"
+ },
+ "midpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "An optional midway interpolation point."
}
},
"id": "GradientRule"
},
- "SetBasicFilterRequest": {
- "description": "Sets the basic filter associated with a sheet.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "The filter to set.",
- "$ref": "BasicFilter"
- }
- },
- "id": "SetBasicFilterRequest"
- },
"ClearValuesRequest": {
"description": "The request for clearing a range of values in a spreadsheet.",
"type": "object",
"properties": {},
"id": "ClearValuesRequest"
},
+ "SetBasicFilterRequest": {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "The filter to set.",
+ "$ref": "BasicFilter"
+ }
+ },
+ "id": "SetBasicFilterRequest",
+ "description": "Sets the basic filter associated with a sheet."
+ },
"InterpolationPoint": {
"description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.",
"type": "object",
"properties": {
- "value": {
- "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
- "type": "string"
- },
"color": {
"$ref": "Color",
"description": "The color this interpolation point should use."
},
"type": {
- "description": "How the value should be interpreted.",
"type": "string",
"enumDescriptions": [
"The default value, do not use.",
@@ -1048,43 +1153,16 @@
"NUMBER",
"PERCENT",
"PERCENTILE"
- ]
+ ],
+ "description": "How the value should be interpreted."
+ },
+ "value": {
+ "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
+ "type": "string"
}
},
"id": "InterpolationPoint"
},
- "FindReplaceResponse": {
- "description": "The result of the find/replace.",
- "type": "object",
- "properties": {
- "formulasChanged": {
- "format": "int32",
- "description": "The number of formula cells changed.",
- "type": "integer"
- },
- "valuesChanged": {
- "format": "int32",
- "description": "The number of non-formula cells changed.",
- "type": "integer"
- },
- "occurrencesChanged": {
- "format": "int32",
- "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -\u003e `\"Googlo Shoots\"`.",
- "type": "integer"
- },
- "rowsChanged": {
- "format": "int32",
- "description": "The number of rows changed.",
- "type": "integer"
- },
- "sheetsChanged": {
- "format": "int32",
- "description": "The number of sheets changed.",
- "type": "integer"
- }
- },
- "id": "FindReplaceResponse"
- },
"DeleteEmbeddedObjectRequest": {
"description": "Deletes the embedded object with the given ID.",
"type": "object",
@@ -1097,20 +1175,39 @@
},
"id": "DeleteEmbeddedObjectRequest"
},
- "DuplicateFilterViewRequest": {
- "id": "DuplicateFilterViewRequest",
- "description": "Duplicates a particular filter view.",
+ "FindReplaceResponse": {
+ "description": "The result of the find/replace.",
"type": "object",
"properties": {
- "filterId": {
+ "occurrencesChanged": {
"format": "int32",
- "description": "The ID of the filter being duplicated.",
+ "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\"`.",
+ "type": "integer"
+ },
+ "rowsChanged": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of rows changed."
+ },
+ "sheetsChanged": {
+ "format": "int32",
+ "description": "The number of sheets changed.",
+ "type": "integer"
+ },
+ "formulasChanged": {
+ "format": "int32",
+ "description": "The number of formula cells changed.",
+ "type": "integer"
+ },
+ "valuesChanged": {
+ "format": "int32",
+ "description": "The number of non-formula cells changed.",
"type": "integer"
}
- }
+ },
+ "id": "FindReplaceResponse"
},
"DeleteSheetRequest": {
- "id": "DeleteSheetRequest",
"description": "Deletes the requested sheet.",
"type": "object",
"properties": {
@@ -1119,10 +1216,22 @@
"description": "The ID of the sheet to delete.",
"type": "integer"
}
- }
+ },
+ "id": "DeleteSheetRequest"
+ },
+ "DuplicateFilterViewRequest": {
+ "description": "Duplicates a particular filter view.",
+ "type": "object",
+ "properties": {
+ "filterId": {
+ "format": "int32",
+ "description": "The ID of the filter being duplicated.",
+ "type": "integer"
+ }
+ },
+ "id": "DuplicateFilterViewRequest"
},
"UpdateConditionalFormatRuleResponse": {
- "description": "The result of updating a conditional format rule.",
"type": "object",
"properties": {
"newIndex": {
@@ -1131,8 +1240,8 @@
"type": "integer"
},
"newRule": {
- "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)",
- "$ref": "ConditionalFormatRule"
+ "$ref": "ConditionalFormatRule",
+ "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
},
"oldIndex": {
"format": "int32",
@@ -1140,40 +1249,14 @@
"type": "integer"
},
"oldRule": {
- "$ref": "ConditionalFormatRule",
- "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule)."
+ "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule).",
+ "$ref": "ConditionalFormatRule"
}
},
- "id": "UpdateConditionalFormatRuleResponse"
- },
- "DuplicateSheetRequest": {
- "description": "Duplicates the contents of a sheet.",
- "type": "object",
- "properties": {
- "newSheetName": {
- "description": "The name of the new sheet. If empty, a new name is chosen for you.",
- "type": "string"
- },
- "sourceSheetId": {
- "format": "int32",
- "description": "The sheet to duplicate.",
- "type": "integer"
- },
- "newSheetId": {
- "format": "int32",
- "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
- "type": "integer"
- },
- "insertSheetIndex": {
- "format": "int32",
- "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
- "type": "integer"
- }
- },
- "id": "DuplicateSheetRequest"
+ "id": "UpdateConditionalFormatRuleResponse",
+ "description": "The result of updating a conditional format rule."
},
"ConditionValue": {
- "id": "ConditionValue",
"description": "The value of the condition.",
"type": "object",
"properties": {
@@ -1182,6 +1265,8 @@
"type": "string"
},
"relativeDate": {
+ "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
+ "type": "string",
"enumDescriptions": [
"Default value, do not use.",
"The value is one year before today.",
@@ -1199,24 +1284,44 @@
"YESTERDAY",
"TODAY",
"TOMORROW"
- ],
- "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
- "type": "string"
+ ]
}
- }
+ },
+ "id": "ConditionValue"
+ },
+ "DuplicateSheetRequest": {
+ "type": "object",
+ "properties": {
+ "insertSheetIndex": {
+ "format": "int32",
+ "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
+ "type": "integer"
+ },
+ "newSheetName": {
+ "description": "The name of the new sheet. If empty, a new name is chosen for you.",
+ "type": "string"
+ },
+ "sourceSheetId": {
+ "format": "int32",
+ "description": "The sheet to duplicate.",
+ "type": "integer"
+ },
+ "newSheetId": {
+ "format": "int32",
+ "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
+ "type": "integer"
+ }
+ },
+ "id": "DuplicateSheetRequest",
+ "description": "Duplicates the contents of a sheet."
},
"ExtendedValue": {
"description": "The kinds of value that a cell in a spreadsheet can have.",
"type": "object",
"properties": {
- "numberValue": {
- "format": "double",
- "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
- "type": "number"
- },
"errorValue": {
- "description": "Represents an error.\nThis field is read-only.",
- "$ref": "ErrorValue"
+ "$ref": "ErrorValue",
+ "description": "Represents an error.\nThis field is read-only."
},
"formulaValue": {
"description": "Represents a formula.",
@@ -1229,63 +1334,55 @@
"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"
+ },
+ "numberValue": {
+ "format": "double",
+ "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
+ "type": "number"
}
},
"id": "ExtendedValue"
},
- "AddChartRequest": {
- "id": "AddChartRequest",
- "description": "Adds a chart to a sheet in the spreadsheet.",
- "type": "object",
- "properties": {
- "chart": {
- "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)",
- "$ref": "EmbeddedChart"
- }
- }
- },
"BandedRange": {
- "id": "BandedRange",
"description": "A banded (alternating colors) range in a sheet.",
"type": "object",
"properties": {
+ "bandedRangeId": {
+ "format": "int32",
+ "description": "The id of the banded range.",
+ "type": "integer"
+ },
"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"
},
"rowProperties": {
- "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified.",
- "$ref": "BandingProperties"
+ "$ref": "BandingProperties",
+ "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified."
},
"range": {
"$ref": "GridRange",
"description": "The range over which these properties are applied."
- },
- "bandedRangeId": {
- "format": "int32",
- "description": "The id of the banded range.",
- "type": "integer"
}
- }
+ },
+ "id": "BandedRange"
},
"HistogramSeries": {
- "id": "HistogramSeries",
- "description": "A histogram series containing the series color and data.",
"type": "object",
"properties": {
- "barColor": {
- "description": "The color of the column representing this series in each bucket.\nThis field is optional.",
- "$ref": "Color"
- },
"data": {
- "$ref": "ChartData",
- "description": "The data for this histogram series."
+ "description": "The data for this histogram series.",
+ "$ref": "ChartData"
+ },
+ "barColor": {
+ "$ref": "Color",
+ "description": "The color of the column representing this series in each bucket.\nThis field is optional."
}
- }
+ },
+ "id": "HistogramSeries",
+ "description": "A histogram series containing the series color and data."
},
"BatchClearValuesResponse": {
- "id": "BatchClearValuesResponse",
- "description": "The response when clearing a range of values in a spreadsheet.",
"type": "object",
"properties": {
"spreadsheetId": {
@@ -1293,17 +1390,17 @@
"type": "string"
},
"clearedRanges": {
- "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "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",
+ "description": "The response when clearing a range of values in a spreadsheet."
},
"Spreadsheet": {
- "description": "Resource that represents a spreadsheet.",
- "type": "object",
"properties": {
"properties": {
"$ref": "SpreadsheetProperties",
@@ -1332,10 +1429,22 @@
"type": "string"
}
},
- "id": "Spreadsheet"
+ "id": "Spreadsheet",
+ "description": "Resource that represents a spreadsheet.",
+ "type": "object"
+ },
+ "AddChartRequest": {
+ "description": "Adds a chart to a sheet in the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "chart": {
+ "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)",
+ "$ref": "EmbeddedChart"
+ }
+ },
+ "id": "AddChartRequest"
},
"UpdateProtectedRangeRequest": {
- "id": "UpdateProtectedRangeRequest",
"description": "Updates an existing protected range with the specified\nprotectedRangeId.",
"type": "object",
"properties": {
@@ -1345,16 +1454,35 @@
"type": "string"
},
"protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to update with the new properties."
+ "description": "The protected range to update with the new properties.",
+ "$ref": "ProtectedRange"
}
- }
+ },
+ "id": "UpdateProtectedRangeRequest"
},
"TextFormat": {
- "id": "TextFormat",
- "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
- "type": "object",
"properties": {
+ "fontSize": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The size of the font."
+ },
+ "underline": {
+ "description": "True if the text is underlined.",
+ "type": "boolean"
+ },
+ "bold": {
+ "type": "boolean",
+ "description": "True if the text is bold."
+ },
+ "foregroundColor": {
+ "$ref": "Color",
+ "description": "The foreground color of the text."
+ },
+ "fontFamily": {
+ "type": "string",
+ "description": "The font family."
+ },
"strikethrough": {
"description": "True if the text has a strikethrough.",
"type": "boolean"
@@ -1362,32 +1490,13 @@
"italic": {
"description": "True if the text is italicized.",
"type": "boolean"
- },
- "fontSize": {
- "format": "int32",
- "description": "The size of the font.",
- "type": "integer"
- },
- "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"
}
- }
+ },
+ "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": {
- "description": "The result of adding a sheet.",
"type": "object",
"properties": {
"properties": {
@@ -1395,10 +1504,10 @@
"$ref": "SheetProperties"
}
},
- "id": "AddSheetResponse"
+ "id": "AddSheetResponse",
+ "description": "The result of adding a sheet."
},
"AddFilterViewResponse": {
- "id": "AddFilterViewResponse",
"description": "The result of adding a filter view.",
"type": "object",
"properties": {
@@ -1406,11 +1515,10 @@
"$ref": "FilterView",
"description": "The newly added filter view."
}
- }
+ },
+ "id": "AddFilterViewResponse"
},
"IterativeCalculationSettings": {
- "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
- "type": "object",
"properties": {
"convergenceThreshold": {
"format": "double",
@@ -1423,64 +1531,14 @@
"type": "integer"
}
},
- "id": "IterativeCalculationSettings"
- },
- "SpreadsheetProperties": {
- "id": "SpreadsheetProperties",
- "description": "Properties of a spreadsheet.",
- "type": "object",
- "properties": {
- "autoRecalc": {
- "description": "The amount of time to wait before volatile functions are recalculated.",
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "Volatile functions are updated on every change.",
- "Volatile functions are updated on every change and every minute.",
- "Volatile functions are updated on every change and hourly."
- ],
- "enum": [
- "RECALCULATION_INTERVAL_UNSPECIFIED",
- "ON_CHANGE",
- "MINUTE",
- "HOUR"
- ]
- },
- "defaultFormat": {
- "$ref": "CellFormat",
- "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only."
- },
- "timeZone": {
- "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
- "type": "string"
- },
- "title": {
- "description": "The title of the spreadsheet.",
- "type": "string"
- },
- "locale": {
- "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
- "type": "string"
- },
- "iterativeCalculationSettings": {
- "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors.",
- "$ref": "IterativeCalculationSettings"
- }
- }
+ "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": {
- "offsetXPixels": {
- "format": "int32",
- "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "type": "integer"
- },
- "anchorCell": {
- "$ref": "GridCoordinate",
- "description": "The cell the object is anchored to."
- },
"heightPixels": {
"format": "int32",
"description": "The height of the object, in pixels. Defaults to 371.",
@@ -1495,12 +1553,63 @@
"format": "int32",
"description": "The width of the object, in pixels. Defaults to 600.",
"type": "integer"
+ },
+ "offsetXPixels": {
+ "format": "int32",
+ "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "type": "integer"
+ },
+ "anchorCell": {
+ "$ref": "GridCoordinate",
+ "description": "The cell the object is anchored to."
}
},
"id": "OverlayPosition"
},
+ "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."
+ },
+ "autoRecalc": {
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "Volatile functions are updated on every change.",
+ "Volatile functions are updated on every change and every minute.",
+ "Volatile functions are updated on every change and hourly."
+ ],
+ "enum": [
+ "RECALCULATION_INTERVAL_UNSPECIFIED",
+ "ON_CHANGE",
+ "MINUTE",
+ "HOUR"
+ ],
+ "description": "The amount of time to wait before volatile functions are recalculated.",
+ "type": "string"
+ },
+ "defaultFormat": {
+ "$ref": "CellFormat",
+ "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only."
+ }
+ },
+ "id": "SpreadsheetProperties"
+ },
"RepeatCellRequest": {
- "id": "RepeatCellRequest",
"description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.\n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.",
"type": "object",
"properties": {
@@ -1509,15 +1618,16 @@
"description": "The range to repeat the cell in."
},
"fields": {
+ "type": "string",
"format": "google-fieldmask",
- "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.",
- "type": "string"
+ "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."
},
"cell": {
"description": "The data to write.",
"$ref": "CellData"
}
- }
+ },
+ "id": "RepeatCellRequest"
},
"AddChartResponse": {
"description": "The result of adding a chart to a spreadsheet.",
@@ -1531,7 +1641,6 @@
"id": "AddChartResponse"
},
"InsertDimensionRequest": {
- "id": "InsertDimensionRequest",
"description": "Inserts rows or columns in a sheet at a particular index.",
"type": "object",
"properties": {
@@ -1543,40 +1652,49 @@
"$ref": "DimensionRange",
"description": "The dimensions to insert. Both the start and end indexes must be bounded."
}
- }
+ },
+ "id": "InsertDimensionRequest"
},
"UpdateSpreadsheetPropertiesRequest": {
- "id": "UpdateSpreadsheetPropertiesRequest",
"description": "Updates properties of a spreadsheet.",
"type": "object",
"properties": {
- "properties": {
- "description": "The properties to update.",
- "$ref": "SpreadsheetProperties"
- },
"fields": {
"format": "google-fieldmask",
"description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
"type": "string"
+ },
+ "properties": {
+ "description": "The properties to update.",
+ "$ref": "SpreadsheetProperties"
}
- }
+ },
+ "id": "UpdateSpreadsheetPropertiesRequest"
},
"ProtectedRange": {
- "id": "ProtectedRange",
"description": "A protected range.",
"type": "object",
"properties": {
+ "namedRangeId": {
+ "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "type": "string"
+ },
+ "protectedRangeId": {
+ "format": "int32",
+ "description": "The ID of the protected range.\nThis field is read-only.",
+ "type": "integer"
+ },
"warningOnly": {
"description": "True if this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is ignored.\nAdditionally, if this field is changed from true to false and the\n`editors` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.",
"type": "boolean"
},
"requestingUserCanEdit": {
- "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only."
},
"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"
+ "$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",
@@ -1587,22 +1705,14 @@
"type": "string"
},
"unprotectedRanges": {
- "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
"items": {
"$ref": "GridRange"
},
- "type": "array"
- },
- "namedRangeId": {
- "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
- },
- "protectedRangeId": {
- "format": "int32",
- "description": "The ID of the protected range.\nThis field is read-only.",
- "type": "integer"
+ "type": "array",
+ "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets."
}
- }
+ },
+ "id": "ProtectedRange"
},
"BatchUpdateValuesRequest": {
"description": "The request for updating more than one range of values in a spreadsheet.",
@@ -1648,6 +1758,8 @@
]
},
"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)."
@@ -1655,15 +1767,12 @@
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
- "type": "string"
+ ]
}
},
"id": "BatchUpdateValuesRequest"
},
"DimensionProperties": {
- "id": "DimensionProperties",
"description": "Properties about a dimension.",
"type": "object",
"properties": {
@@ -1680,20 +1789,15 @@
"description": "True if this dimension is being filtered.\nThis field is read-only.",
"type": "boolean"
}
- }
+ },
+ "id": "DimensionProperties"
},
"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": {
- "sheetId": {
- "format": "int32",
- "description": "The sheet this span is on.",
- "type": "integer"
- },
"dimension": {
- "description": "The dimension of the span.",
- "type": "string",
"enumDescriptions": [
"The default value, do not use.",
"Operates on the rows of a sheet.",
@@ -1703,7 +1807,9 @@
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
- ]
+ ],
+ "description": "The dimension of the span.",
+ "type": "string"
},
"endIndex": {
"format": "int32",
@@ -1714,9 +1820,13 @@
"format": "int32",
"description": "The start (inclusive) of the span, or not set if unbounded.",
"type": "integer"
+ },
+ "sheetId": {
+ "format": "int32",
+ "description": "The sheet this span is on.",
+ "type": "integer"
}
- },
- "id": "DimensionRange"
+ }
},
"NamedRange": {
"description": "A named range.",
@@ -1727,8 +1837,8 @@
"type": "string"
},
"range": {
- "$ref": "GridRange",
- "description": "The range this represents."
+ "description": "The range this represents.",
+ "$ref": "GridRange"
},
"name": {
"description": "The name of the named range.",
@@ -1742,10 +1852,12 @@
"type": "object",
"properties": {
"destination": {
- "$ref": "GridCoordinate",
- "description": "The top-left coordinate where the data should be pasted."
+ "description": "The top-left coordinate where the data should be pasted.",
+ "$ref": "GridCoordinate"
},
"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.",
@@ -1763,37 +1875,17 @@
"PASTE_FORMULA",
"PASTE_DATA_VALIDATION",
"PASTE_CONDITIONAL_FORMATTING"
- ],
- "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
- "type": "string"
+ ]
},
"source": {
- "description": "The source data to cut.",
- "$ref": "GridRange"
+ "$ref": "GridRange",
+ "description": "The source data to cut."
}
},
"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": {
- "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"
- ]
- },
"type": {
"enumDescriptions": [
"Default value, do not use.",
@@ -1819,37 +1911,54 @@
"type": "string"
},
"series": {
- "$ref": "ChartData",
- "description": "The data being visualized in this chart series."
+ "description": "The data being visualized in this chart series.",
+ "$ref": "ChartData"
+ },
+ "targetAxis": {
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
+ "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ]
}
},
- "id": "BasicChartSeries"
+ "id": "BasicChartSeries",
+ "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
+ "type": "object"
},
"Borders": {
- "id": "Borders",
- "description": "The borders of the cell.",
"type": "object",
"properties": {
- "right": {
- "description": "The right border of the cell.",
+ "left": {
+ "description": "The left border of the cell.",
"$ref": "Border"
},
+ "right": {
+ "$ref": "Border",
+ "description": "The right border of the cell."
+ },
"bottom": {
- "description": "The bottom border of the cell.",
- "$ref": "Border"
+ "$ref": "Border",
+ "description": "The bottom border of the cell."
},
"top": {
- "$ref": "Border",
- "description": "The top border of the cell."
- },
- "left": {
- "$ref": "Border",
- "description": "The left border of the cell."
+ "description": "The top border of the cell.",
+ "$ref": "Border"
}
- }
+ },
+ "id": "Borders",
+ "description": "The borders of the cell."
},
"AutoResizeDimensionsRequest": {
- "id": "AutoResizeDimensionsRequest",
"description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
"type": "object",
"properties": {
@@ -1857,24 +1966,16 @@
"description": "The dimensions to automatically resize.",
"$ref": "DimensionRange"
}
- }
+ },
+ "id": "AutoResizeDimensionsRequest"
},
"UpdateBordersRequest": {
- "id": "UpdateBordersRequest",
"description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.",
"type": "object",
"properties": {
- "bottom": {
- "description": "The border to put at the bottom of the range.",
- "$ref": "Border"
- },
- "innerVertical": {
- "$ref": "Border",
- "description": "The vertical border to put within the range."
- },
"right": {
- "$ref": "Border",
- "description": "The border to put at the right of the range."
+ "description": "The border to put at the right of the range.",
+ "$ref": "Border"
},
"range": {
"$ref": "GridRange",
@@ -1891,57 +1992,33 @@
"left": {
"description": "The border to put at the left of the range.",
"$ref": "Border"
+ },
+ "bottom": {
+ "$ref": "Border",
+ "description": "The border to put at the bottom of the range."
+ },
+ "innerVertical": {
+ "description": "The vertical border to put within the range.",
+ "$ref": "Border"
}
- }
+ },
+ "id": "UpdateBordersRequest"
},
"CellFormat": {
- "id": "CellFormat",
"description": "The format of a cell.",
"type": "object",
"properties": {
- "numberFormat": {
- "$ref": "NumberFormat",
- "description": "A format describing how number values should be represented to the user."
- },
- "hyperlinkDisplayType": {
- "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"
- ],
- "description": "How a hyperlink, if it exists, should be displayed in the cell.",
- "type": "string"
- },
- "horizontalAlignment": {
- "description": "The horizontal alignment of the value in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The horizontal alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the left of the cell.",
- "The text is explicitly aligned to the center of the cell.",
- "The text is explicitly aligned to the right of the cell."
- ],
- "enum": [
- "HORIZONTAL_ALIGN_UNSPECIFIED",
- "LEFT",
- "CENTER",
- "RIGHT"
- ]
- },
- "textFormat": {
- "$ref": "TextFormat",
- "description": "The format of the text in the cell (unless overridden by a format run)."
- },
"backgroundColor": {
- "description": "The background color of the cell.",
- "$ref": "Color"
+ "$ref": "Color",
+ "description": "The background color of the cell."
+ },
+ "padding": {
+ "$ref": "Padding",
+ "description": "The padding of the cell."
},
"verticalAlignment": {
+ "description": "The vertical alignment of the value in the cell.",
+ "type": "string",
"enumDescriptions": [
"The vertical alignment is not specified. Do not use this.",
"The text is explicitly aligned to the top of the cell.",
@@ -1953,13 +2030,11 @@
"TOP",
"MIDDLE",
"BOTTOM"
- ],
- "description": "The vertical alignment of the value in the cell.",
- "type": "string"
+ ]
},
- "padding": {
- "description": "The padding of the cell.",
- "$ref": "Padding"
+ "borders": {
+ "$ref": "Borders",
+ "description": "The borders of the cell."
},
"textDirection": {
"description": "The direction of the text in the cell.",
@@ -1975,17 +2050,11 @@
"RIGHT_TO_LEFT"
]
},
- "borders": {
- "description": "The borders of the cell.",
- "$ref": "Borders"
- },
"textRotation": {
"description": "The rotation applied to text in a cell",
"$ref": "TextRotation"
},
"wrapStrategy": {
- "description": "The wrap strategy for the value in the cell.",
- "type": "string",
"enumDescriptions": [
"The default value, do not use.",
"Lines that are longer than the cell width will be written in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. \u003c- Text continues into next cell\n | Next newline. |",
@@ -1999,27 +2068,67 @@
"LEGACY_WRAP",
"CLIP",
"WRAP"
- ]
- }
- }
- },
- "ClearValuesResponse": {
- "id": "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.",
+ ],
+ "description": "The wrap strategy for the value in the cell.",
"type": "string"
},
+ "numberFormat": {
+ "$ref": "NumberFormat",
+ "description": "A format describing how number values should be represented to the user."
+ },
+ "horizontalAlignment": {
+ "type": "string",
+ "enumDescriptions": [
+ "The horizontal alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the left of the cell.",
+ "The text is explicitly aligned to the center of the cell.",
+ "The text is explicitly aligned to the right of the cell."
+ ],
+ "enum": [
+ "HORIZONTAL_ALIGN_UNSPECIFIED",
+ "LEFT",
+ "CENTER",
+ "RIGHT"
+ ],
+ "description": "The horizontal alignment of the value in the cell."
+ },
+ "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)."
+ }
+ },
+ "id": "CellFormat"
+ },
+ "ClearValuesResponse": {
+ "properties": {
"clearedRange": {
"description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
"type": "string"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
}
- }
+ },
+ "id": "ClearValuesResponse",
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "type": "object"
},
"DeleteConditionalFormatRuleRequest": {
- "id": "DeleteConditionalFormatRuleRequest",
"description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
"type": "object",
"properties": {
@@ -2033,10 +2142,21 @@
"description": "The sheet the rule is being deleted from.",
"type": "integer"
}
- }
+ },
+ "id": "DeleteConditionalFormatRuleRequest"
+ },
+ "AddBandingResponse": {
+ "description": "The result of adding a banded range.",
+ "type": "object",
+ "properties": {
+ "bandedRange": {
+ "$ref": "BandedRange",
+ "description": "The banded range that was added."
+ }
+ },
+ "id": "AddBandingResponse"
},
"DeleteNamedRangeRequest": {
- "id": "DeleteNamedRangeRequest",
"description": "Removes the named range with the given ID from the spreadsheet.",
"type": "object",
"properties": {
@@ -2044,21 +2164,10 @@
"description": "The ID of the named range to delete.",
"type": "string"
}
- }
- },
- "AddBandingResponse": {
- "description": "The result of adding a banded range.",
- "type": "object",
- "properties": {
- "bandedRange": {
- "description": "The banded range that was added.",
- "$ref": "BandedRange"
- }
},
- "id": "AddBandingResponse"
+ "id": "DeleteNamedRangeRequest"
},
"ChartData": {
- "id": "ChartData",
"description": "The data included in a domain or series.",
"type": "object",
"properties": {
@@ -2066,11 +2175,10 @@
"description": "The source ranges of the data.",
"$ref": "ChartSourceRange"
}
- }
+ },
+ "id": "ChartData"
},
"BatchGetValuesResponse": {
- "description": "The response when retrieving more than one range of values in a spreadsheet.",
- "type": "object",
"properties": {
"valueRanges": {
"description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.",
@@ -2084,28 +2192,35 @@
"type": "string"
}
},
- "id": "BatchGetValuesResponse"
+ "id": "BatchGetValuesResponse",
+ "description": "The response when retrieving more than one range of values in a spreadsheet.",
+ "type": "object"
},
"UpdateBandingRequest": {
- "id": "UpdateBandingRequest",
"description": "Updates properties of the supplied banded range.",
"type": "object",
"properties": {
- "bandedRange": {
- "description": "The banded range to update with the new properties.",
- "$ref": "BandedRange"
- },
"fields": {
"format": "google-fieldmask",
"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.",
"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": {
+ "format": "float",
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "type": "number"
+ },
"alpha": {
"format": "float",
"description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
@@ -2120,23 +2235,31 @@
"format": "float",
"description": "The amount of green in the color as a value in the interval [0, 1].",
"type": "number"
- },
- "red": {
- "format": "float",
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "type": "number"
}
},
"id": "Color"
},
"PivotGroup": {
- "id": "PivotGroup",
"description": "A single grouping (either row or column) in a pivot table.",
"type": "object",
"properties": {
+ "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": {
- "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values.",
- "$ref": "PivotGroupSortValueBucket"
+ "$ref": "PivotGroupSortValueBucket",
+ "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values."
},
"valueMetadata": {
"description": "Metadata about values in the grouping.",
@@ -2153,22 +2276,9 @@
"format": "int32",
"description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
"type": "integer"
- },
- "sortOrder": {
- "description": "The order the values in this group should be sorted.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ],
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ]
}
- }
+ },
+ "id": "PivotGroup"
},
"PivotTable": {
"id": "PivotTable",
@@ -2209,8 +2319,8 @@
"type": "array"
},
"source": {
- "$ref": "GridRange",
- "description": "The range the pivot table is reading data from."
+ "description": "The range the pivot table is reading data from.",
+ "$ref": "GridRange"
},
"columns": {
"description": "Each column grouping in the pivot table.",
@@ -2222,18 +2332,53 @@
}
},
"ChartSourceRange": {
- "id": "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",
"items": {
"$ref": "GridRange"
},
- "type": "array"
+ "type": "array",
+ "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"
+ },
+ "ValueRange": {
+ "description": "Data within a range of the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "items": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "type": "array",
+ "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."
+ },
+ "majorDimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.",
+ "type": "string",
+ "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 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"
},
"AppendCellsRequest": {
"description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
@@ -2259,54 +2404,18 @@
},
"id": "AppendCellsRequest"
},
- "ValueRange": {
- "description": "Data within a range of the spreadsheet.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
- "type": "string"
- },
- "values": {
- "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
- "items": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "type": "array"
- },
- "majorDimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.",
- "type": "string"
- }
- },
- "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.)"
}
- }
+ },
+ "id": "AddBandingRequest",
+ "description": "Adds a new banded range to the spreadsheet."
},
"Response": {
- "id": "Response",
"description": "A single response from an update.",
"type": "object",
"properties": {
@@ -2315,20 +2424,20 @@
"$ref": "AddBandingResponse"
},
"addProtectedRange": {
- "description": "A reply from adding a protected range.",
- "$ref": "AddProtectedRangeResponse"
+ "$ref": "AddProtectedRangeResponse",
+ "description": "A reply from adding a protected range."
},
"duplicateSheet": {
- "description": "A reply from duplicating a sheet.",
- "$ref": "DuplicateSheetResponse"
+ "$ref": "DuplicateSheetResponse",
+ "description": "A reply from duplicating a sheet."
},
"updateEmbeddedObjectPosition": {
"$ref": "UpdateEmbeddedObjectPositionResponse",
"description": "A reply from updating an embedded object's position."
},
"deleteConditionalFormatRule": {
- "description": "A reply from deleting a conditional format rule.",
- "$ref": "DeleteConditionalFormatRuleResponse"
+ "$ref": "DeleteConditionalFormatRuleResponse",
+ "description": "A reply from deleting a conditional format rule."
},
"duplicateFilterView": {
"$ref": "DuplicateFilterViewResponse",
@@ -2339,67 +2448,27 @@
"$ref": "AddChartResponse"
},
"findReplace": {
- "$ref": "FindReplaceResponse",
- "description": "A reply from doing a find/replace."
+ "description": "A reply from doing a find/replace.",
+ "$ref": "FindReplaceResponse"
},
"addSheet": {
"description": "A reply from adding a sheet.",
"$ref": "AddSheetResponse"
},
"updateConditionalFormatRule": {
- "description": "A reply from updating a conditional format rule.",
- "$ref": "UpdateConditionalFormatRuleResponse"
+ "$ref": "UpdateConditionalFormatRuleResponse",
+ "description": "A reply from updating a conditional format rule."
},
"addNamedRange": {
"description": "A reply from adding a named range.",
"$ref": "AddNamedRangeResponse"
},
"addFilterView": {
- "description": "A reply from adding a filter view.",
- "$ref": "AddFilterViewResponse"
- }
- }
- },
- "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"
- }
- }
- },
- "TextFormatRun": {
- "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
- "type": "object",
- "properties": {
- "startIndex": {
- "format": "int32",
- "description": "The character index where this run starts.",
- "type": "integer"
- },
- "format": {
- "$ref": "TextFormat",
- "description": "The format of this run. Absent values inherit the cell's format."
+ "$ref": "AddFilterViewResponse",
+ "description": "A reply from adding a filter view."
}
},
- "id": "TextFormatRun"
+ "id": "Response"
},
"EmbeddedChart": {
"description": "A chart embedded in a sheet.",
@@ -2415,12 +2484,53 @@
"description": "The position of the chart."
},
"spec": {
- "description": "The specification of the chart.",
- "$ref": "ChartSpec"
+ "$ref": "ChartSpec",
+ "description": "The specification of the chart."
}
},
"id": "EmbeddedChart"
},
+ "TextFormatRun": {
+ "properties": {
+ "startIndex": {
+ "format": "int32",
+ "description": "The character index where this run starts.",
+ "type": "integer"
+ },
+ "format": {
+ "$ref": "TextFormat",
+ "description": "The format of this run. Absent values inherit the cell's format."
+ }
+ },
+ "id": "TextFormatRun",
+ "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
+ "type": "object"
+ },
+ "InsertRangeRequest": {
+ "description": "Inserts cells into a range, shifting the existing cells over or down.",
+ "type": "object",
+ "properties": {
+ "shiftDimension": {
+ "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to insert new cells into."
+ }
+ },
+ "id": "InsertRangeRequest"
+ },
"AddNamedRangeResponse": {
"description": "The result of adding a named range.",
"type": "object",
@@ -2433,7 +2543,6 @@
"id": "AddNamedRangeResponse"
},
"RowData": {
- "id": "RowData",
"description": "Data about each cell in a row.",
"type": "object",
"properties": {
@@ -2444,17 +2553,51 @@
},
"type": "array"
}
- }
+ },
+ "id": "RowData"
+ },
+ "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.",
+ "items": {
+ "$ref": "DimensionProperties"
+ },
+ "type": "array"
+ },
+ "rowData": {
+ "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
+ "items": {
+ "$ref": "RowData"
+ },
+ "type": "array"
+ },
+ "startRow": {
+ "format": "int32",
+ "description": "The first row this GridData refers to, zero-based.",
+ "type": "integer"
+ },
+ "columnMetadata": {
+ "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
+ "items": {
+ "$ref": "DimensionProperties"
+ },
+ "type": "array"
+ },
+ "startColumn": {
+ "format": "int32",
+ "description": "The first column this GridData refers to, zero-based.",
+ "type": "integer"
+ }
+ },
+ "id": "GridData"
},
"Border": {
- "id": "Border",
"description": "A border along a cell.",
"type": "object",
"properties": {
- "color": {
- "$ref": "Color",
- "description": "The color of the border."
- },
"width": {
"format": "int32",
"description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
@@ -2483,46 +2626,57 @@
],
"description": "The style of the border.",
"type": "string"
- }
- }
- },
- "GridData": {
- "description": "Data in the grid, as well as metadata about the dimensions.",
- "type": "object",
- "properties": {
- "columnMetadata": {
- "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
- "items": {
- "$ref": "DimensionProperties"
- },
- "type": "array"
},
- "startColumn": {
- "format": "int32",
- "description": "The first column this GridData refers to, zero-based.",
- "type": "integer"
- },
- "rowMetadata": {
- "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
- "items": {
- "$ref": "DimensionProperties"
- },
- "type": "array"
- },
- "rowData": {
- "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
- "items": {
- "$ref": "RowData"
- },
- "type": "array"
- },
- "startRow": {
- "format": "int32",
- "description": "The first row this GridData refers to, zero-based.",
- "type": "integer"
+ "color": {
+ "$ref": "Color",
+ "description": "The color of the border."
}
},
- "id": "GridData"
+ "id": "Border"
+ },
+ "FindReplaceRequest": {
+ "type": "object",
+ "properties": {
+ "includeFormulas": {
+ "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
+ "type": "boolean"
+ },
+ "matchEntireCell": {
+ "description": "True if the find value should match the entire cell.",
+ "type": "boolean"
+ },
+ "find": {
+ "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"
+ },
+ "replacement": {
+ "description": "The value to use as the replacement.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to find/replace over."
+ },
+ "sheetId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The sheet to find/replace over."
+ },
+ "allSheets": {
+ "description": "True to find/replace over all sheets.",
+ "type": "boolean"
+ },
+ "matchCase": {
+ "description": "True if the search is case sensitive.",
+ "type": "boolean"
+ }
+ },
+ "id": "FindReplaceRequest",
+ "description": "Finds and replaces data in cells over a range, sheet, or all sheets."
},
"UpdateNamedRangeRequest": {
"description": "Updates properties of the named range with the specified\nnamedRangeId.",
@@ -2540,68 +2694,25 @@
},
"id": "UpdateNamedRangeRequest"
},
- "FindReplaceRequest": {
- "id": "FindReplaceRequest",
- "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
- "type": "object",
- "properties": {
- "sheetId": {
- "format": "int32",
- "description": "The sheet to find/replace over.",
- "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"
- },
- "searchByRegex": {
- "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.",
- "type": "boolean"
- },
- "find": {
- "description": "The value to search.",
- "type": "string"
- },
- "replacement": {
- "description": "The value to use as the replacement.",
- "type": "string"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range to find/replace over."
- }
- }
- },
"AddSheetRequest": {
- "id": "AddSheetRequest",
- "description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmbeddedObjectPosition.newSheet.",
- "type": "object",
"properties": {
"properties": {
- "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)",
- "$ref": "SheetProperties"
+ "$ref": "SheetProperties",
+ "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)"
}
- }
+ },
+ "id": "AddSheetRequest",
+ "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"
},
"UpdateCellsRequest": {
+ "id": "UpdateCellsRequest",
"description": "Updates all cells in a range with new data.",
"type": "object",
"properties": {
"start": {
- "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written.",
- "$ref": "GridCoordinate"
+ "$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": {
"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.",
@@ -2613,14 +2724,24 @@
"type": "string"
},
"rows": {
- "description": "The data to write.",
"items": {
"$ref": "RowData"
},
- "type": "array"
+ "type": "array",
+ "description": "The data to write."
+ }
+ }
+ },
+ "DeleteConditionalFormatRuleResponse": {
+ "description": "The result of deleting a conditional format rule.",
+ "type": "object",
+ "properties": {
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule that was deleted."
}
},
- "id": "UpdateCellsRequest"
+ "id": "DeleteConditionalFormatRuleResponse"
},
"RandomizeRangeRequest": {
"description": "Randomizes the order of the rows in a range.",
@@ -2633,19 +2754,7 @@
},
"id": "RandomizeRangeRequest"
},
- "DeleteConditionalFormatRuleResponse": {
- "id": "DeleteConditionalFormatRuleResponse",
- "description": "The result of deleting a conditional format rule.",
- "type": "object",
- "properties": {
- "rule": {
- "description": "The rule that was deleted.",
- "$ref": "ConditionalFormatRule"
- }
- }
- },
"DeleteRangeRequest": {
- "id": "DeleteRangeRequest",
"description": "Deletes a range of cells, shifting other cells into the deleted area.",
"type": "object",
"properties": {
@@ -2664,13 +2773,13 @@
"type": "string"
},
"range": {
- "$ref": "GridRange",
- "description": "The range of cells to delete."
+ "description": "The range of cells to delete.",
+ "$ref": "GridRange"
}
- }
+ },
+ "id": "DeleteRangeRequest"
},
"GridCoordinate": {
- "id": "GridCoordinate",
"description": "A coordinate in a sheet.\nAll indexes are zero-based.",
"type": "object",
"properties": {
@@ -2689,10 +2798,10 @@
"description": "The sheet this coordinate is on.",
"type": "integer"
}
- }
+ },
+ "id": "GridCoordinate"
},
"UpdateSheetPropertiesRequest": {
- "id": "UpdateSheetPropertiesRequest",
"description": "Updates properties of the sheet with the specified\nsheetId.",
"type": "object",
"properties": {
@@ -2705,7 +2814,8 @@
"description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
"type": "string"
}
- }
+ },
+ "id": "UpdateSheetPropertiesRequest"
},
"GridProperties": {
"description": "Properties of a grid.",
@@ -2731,9 +2841,9 @@
"type": "integer"
},
"columnCount": {
+ "type": "integer",
"format": "int32",
- "description": "The number of columns in the grid.",
- "type": "integer"
+ "description": "The number of columns in the grid."
}
},
"id": "GridProperties"
@@ -2743,8 +2853,8 @@
"type": "object",
"properties": {
"range": {
- "$ref": "GridRange",
- "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge."
+ "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge.",
+ "$ref": "GridRange"
}
},
"id": "UnmergeCellsRequest"
@@ -2754,23 +2864,23 @@
"type": "object",
"properties": {
"position": {
- "description": "The new position of the embedded object.",
- "$ref": "EmbeddedObjectPosition"
+ "$ref": "EmbeddedObjectPosition",
+ "description": "The new position of the embedded object."
}
},
"id": "UpdateEmbeddedObjectPositionResponse"
},
"SortSpec": {
- "id": "SortSpec",
"description": "A sort order associated with a specific column or row.",
"type": "object",
"properties": {
"dimensionIndex": {
+ "type": "integer",
"format": "int32",
- "description": "The dimension the sort should be applied to.",
- "type": "integer"
+ "description": "The dimension the sort should be applied to."
},
"sortOrder": {
+ "type": "string",
"enumDescriptions": [
"Default value, do not use this.",
"Sort ascending.",
@@ -2781,54 +2891,28 @@
"ASCENDING",
"DESCENDING"
],
- "description": "The order data should be sorted.",
- "type": "string"
+ "description": "The order data should be sorted."
}
- }
+ },
+ "id": "SortSpec"
},
"Sheet": {
- "id": "Sheet",
"description": "A sheet in a spreadsheet.",
"type": "object",
"properties": {
- "bandedRanges": {
- "description": "The banded (i.e. alternating colors) ranges on this sheet.",
- "items": {
- "$ref": "BandedRange"
- },
- "type": "array"
- },
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the sheet."
- },
- "charts": {
- "description": "The specifications of every chart on this sheet.",
- "items": {
- "$ref": "EmbeddedChart"
- },
- "type": "array"
- },
- "filterViews": {
- "description": "The filter views in this sheet.",
- "items": {
- "$ref": "FilterView"
- },
- "type": "array"
- },
- "conditionalFormats": {
- "description": "The conditional format rules in this sheet.",
- "items": {
- "$ref": "ConditionalFormatRule"
- },
- "type": "array"
- },
"protectedRanges": {
- "description": "The protected ranges in this sheet.",
"items": {
"$ref": "ProtectedRange"
},
- "type": "array"
+ "type": "array",
+ "description": "The protected ranges in this sheet."
+ },
+ "conditionalFormats": {
+ "items": {
+ "$ref": "ConditionalFormatRule"
+ },
+ "type": "array",
+ "description": "The conditional format rules in this sheet."
},
"basicFilter": {
"$ref": "BasicFilter",
@@ -2847,26 +2931,51 @@
"$ref": "GridData"
},
"type": "array"
+ },
+ "bandedRanges": {
+ "description": "The banded (i.e. alternating colors) ranges on this sheet.",
+ "items": {
+ "$ref": "BandedRange"
+ },
+ "type": "array"
+ },
+ "charts": {
+ "description": "The specifications of every chart on this sheet.",
+ "items": {
+ "$ref": "EmbeddedChart"
+ },
+ "type": "array"
+ },
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the sheet."
+ },
+ "filterViews": {
+ "items": {
+ "$ref": "FilterView"
+ },
+ "type": "array",
+ "description": "The filter views in this sheet."
}
- }
+ },
+ "id": "Sheet"
},
"BooleanRule": {
- "description": "A rule that may or may not match, depending on the condition.",
"type": "object",
"properties": {
"format": {
- "$ref": "CellFormat",
- "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
+ "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."
+ "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied.",
+ "$ref": "BooleanCondition"
}
},
- "id": "BooleanRule"
+ "id": "BooleanRule",
+ "description": "A rule that may or may not match, depending on the condition."
},
"PivotGroupValueMetadata": {
- "id": "PivotGroupValueMetadata",
"description": "Metadata about a value in a pivot grouping.",
"type": "object",
"properties": {
@@ -2878,16 +2987,16 @@
"description": "True if the data corresponding to the value is collapsed.",
"type": "boolean"
}
- }
+ },
+ "id": "PivotGroupValueMetadata"
},
"FilterCriteria": {
- "id": "FilterCriteria",
"description": "Criteria for showing/hiding rows in a filter or filter view.",
"type": "object",
"properties": {
"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.)"
+ "description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)",
+ "$ref": "BooleanCondition"
},
"hiddenValues": {
"description": "Values that should be hidden.",
@@ -2896,19 +3005,14 @@
},
"type": "array"
}
- }
+ },
+ "id": "FilterCriteria"
},
"Editors": {
+ "id": "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"domainUsersCanEdit": {
"description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
"type": "boolean"
@@ -2919,14 +3023,30 @@
"type": "string"
},
"type": "array"
+ },
+ "users": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "The email addresses of users with edit access to the protected range."
}
- },
- "id": "Editors"
+ }
},
"UpdateConditionalFormatRuleRequest": {
"description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
"type": "object",
"properties": {
+ "sheetId": {
+ "format": "int32",
+ "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
+ "type": "integer"
+ },
+ "newIndex": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The zero-based new index the rule should end up at."
+ },
"rule": {
"$ref": "ConditionalFormatRule",
"description": "The rule that should replace the rule at the given index."
@@ -2935,16 +3055,6 @@
"format": "int32",
"description": "The zero-based index of the rule that should be replaced or moved.",
"type": "integer"
- },
- "sheetId": {
- "format": "int32",
- "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
- "type": "integer"
- },
- "newIndex": {
- "format": "int32",
- "description": "The zero-based new index the rule should end up at.",
- "type": "integer"
}
},
"id": "UpdateConditionalFormatRuleRequest"
@@ -2973,23 +3083,21 @@
"id": "DataValidationRule"
},
"BasicChartDomain": {
- "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
"type": "object",
"properties": {
"domain": {
- "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates.",
- "$ref": "ChartData"
+ "$ref": "ChartData",
+ "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates."
},
"reversed": {
"description": "True to reverse the order of the domain values (horizontal axis).",
"type": "boolean"
}
},
- "id": "BasicChartDomain"
+ "id": "BasicChartDomain",
+ "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date."
},
"PasteDataRequest": {
- "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
- "type": "object",
"properties": {
"type": {
"description": "How the data should be pasted.",
@@ -3030,17 +3138,14 @@
"type": "string"
}
},
- "id": "PasteDataRequest"
+ "id": "PasteDataRequest",
+ "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
+ "type": "object"
},
"AppendDimensionRequest": {
"description": "Appends rows or columns to the end of a sheet.",
"type": "object",
"properties": {
- "sheetId": {
- "format": "int32",
- "description": "The sheet to append rows or columns to.",
- "type": "integer"
- },
"dimension": {
"description": "Whether rows or columns should be appended.",
"type": "string",
@@ -3056,8 +3161,13 @@
]
},
"length": {
+ "type": "integer",
"format": "int32",
- "description": "The number of rows or columns to append.",
+ "description": "The number of rows or columns to append."
+ },
+ "sheetId": {
+ "format": "int32",
+ "description": "The sheet to append rows or columns to.",
"type": "integer"
}
},
@@ -3075,7 +3185,6 @@
"id": "AddNamedRangeRequest"
},
"UpdateEmbeddedObjectPositionRequest": {
- "id": "UpdateEmbeddedObjectPositionRequest",
"description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
"type": "object",
"properties": {
@@ -3085,18 +3194,18 @@
"type": "integer"
},
"newPosition": {
- "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you.",
- "$ref": "EmbeddedObjectPosition"
+ "$ref": "EmbeddedObjectPosition",
+ "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you."
},
"fields": {
"format": "google-fieldmask",
"description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
"type": "string"
}
- }
+ },
+ "id": "UpdateEmbeddedObjectPositionRequest"
},
"TextRotation": {
- "id": "TextRotation",
"description": "The rotation applied to text in a cell.",
"type": "object",
"properties": {
@@ -3109,20 +3218,18 @@
"description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
"type": "boolean"
}
- }
+ },
+ "id": "TextRotation"
},
"PieChartSpec": {
+ "id": "PieChartSpec",
"description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
"type": "object",
"properties": {
- "series": {
- "$ref": "ChartData",
- "description": "The data that covers the one and only series of the pie chart."
- },
"pieHole": {
+ "type": "number",
"format": "double",
- "description": "The size of the hole in the pie chart.",
- "type": "number"
+ "description": "The size of the hole in the pie chart."
},
"legendPosition": {
"description": "Where the legend of the pie chart should be drawn.",
@@ -3151,11 +3258,14 @@
"type": "boolean"
},
"domain": {
- "description": "The data that covers the domain of the pie chart.",
- "$ref": "ChartData"
+ "$ref": "ChartData",
+ "description": "The data that covers the domain of the pie chart."
+ },
+ "series": {
+ "$ref": "ChartData",
+ "description": "The data that covers the one and only series of the pie chart."
}
- },
- "id": "PieChartSpec"
+ }
},
"UpdateFilterViewRequest": {
"description": "Updates properties of the filter view.",
@@ -3174,9 +3284,6 @@
"id": "UpdateFilterViewRequest"
},
"ConditionalFormatRule": {
- "id": "ConditionalFormatRule",
- "description": "A rule describing a conditional format.",
- "type": "object",
"properties": {
"ranges": {
"description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
@@ -3190,13 +3297,15 @@
"description": "The formatting will vary based on the gradients in the rule."
},
"booleanRule": {
- "description": "The formatting is either \"on\" or \"off\" according to the rule.",
- "$ref": "BooleanRule"
+ "$ref": "BooleanRule",
+ "description": "The formatting is either \"on\" or \"off\" according to the rule."
}
- }
+ },
+ "id": "ConditionalFormatRule",
+ "description": "A rule describing a conditional format.",
+ "type": "object"
},
"CopyPasteRequest": {
- "description": "Copies data from the source to the destination.",
"type": "object",
"properties": {
"pasteType": {
@@ -3230,19 +3339,20 @@
"$ref": "GridRange"
},
"pasteOrientation": {
+ "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."
- ],
- "enum": [
- "NORMAL",
- "TRANSPOSE"
]
}
},
- "id": "CopyPasteRequest"
+ "id": "CopyPasteRequest",
+ "description": "Copies data from the source to the destination."
},
"BooleanCondition": {
"description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.",
@@ -3256,8 +3366,6 @@
"type": "array"
},
"type": {
- "description": "The type of condition.",
- "type": "string",
"enumDescriptions": [
"The default value, do not use.",
"The cell's value must be greater than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
@@ -3319,183 +3427,44 @@
"BLANK",
"NOT_BLANK",
"CUSTOM_FORMULA"
- ]
+ ],
+ "description": "The type of condition.",
+ "type": "string"
}
},
"id": "BooleanCondition"
},
"Request": {
- "id": "Request",
"description": "A single kind of update to apply to a spreadsheet.",
"type": "object",
"properties": {
- "updateCells": {
- "description": "Updates many cells at once.",
- "$ref": "UpdateCellsRequest"
- },
- "addNamedRange": {
- "description": "Adds a named range.",
- "$ref": "AddNamedRangeRequest"
- },
- "updateSpreadsheetProperties": {
- "$ref": "UpdateSpreadsheetPropertiesRequest",
- "description": "Updates the spreadsheet's properties."
- },
- "deleteEmbeddedObject": {
- "description": "Deletes an embedded object (e.g, chart, image) in a sheet.",
- "$ref": "DeleteEmbeddedObjectRequest"
- },
- "updateFilterView": {
- "$ref": "UpdateFilterViewRequest",
- "description": "Updates the properties of a filter view."
- },
- "addBanding": {
- "description": "Adds a new banded range",
- "$ref": "AddBandingRequest"
- },
- "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."
- },
- "cutPaste": {
- "description": "Cuts data from one area and pastes it to another.",
- "$ref": "CutPasteRequest"
- },
- "mergeCells": {
- "$ref": "MergeCellsRequest",
- "description": "Merges cells together."
- },
- "updateNamedRange": {
- "description": "Updates a named range.",
- "$ref": "UpdateNamedRangeRequest"
- },
- "updateSheetProperties": {
- "description": "Updates a sheet's properties.",
- "$ref": "UpdateSheetPropertiesRequest"
- },
- "deleteDimension": {
- "description": "Deletes rows or columns in a sheet.",
- "$ref": "DeleteDimensionRequest"
- },
- "autoFill": {
- "description": "Automatically fills in more data based on existing data.",
- "$ref": "AutoFillRequest"
- },
- "sortRange": {
- "description": "Sorts data in a range.",
- "$ref": "SortRangeRequest"
- },
- "deleteProtectedRange": {
- "description": "Deletes a protected range.",
- "$ref": "DeleteProtectedRangeRequest"
- },
- "duplicateFilterView": {
- "description": "Duplicates a filter view.",
- "$ref": "DuplicateFilterViewRequest"
- },
- "addChart": {
- "$ref": "AddChartRequest",
- "description": "Adds a chart."
- },
- "findReplace": {
- "description": "Finds and replaces occurrences of some text with other text.",
- "$ref": "FindReplaceRequest"
- },
- "textToColumns": {
- "$ref": "TextToColumnsRequest",
- "description": "Converts a column of text into many columns of text."
- },
- "updateChartSpec": {
- "description": "Updates a chart's specifications.",
- "$ref": "UpdateChartSpecRequest"
- },
- "addSheet": {
- "$ref": "AddSheetRequest",
- "description": "Adds a sheet."
- },
- "updateProtectedRange": {
- "$ref": "UpdateProtectedRangeRequest",
- "description": "Updates a protected range."
- },
- "deleteFilterView": {
- "$ref": "DeleteFilterViewRequest",
- "description": "Deletes a filter view from a sheet."
- },
- "copyPaste": {
- "description": "Copies data from one area and pastes it to another.",
- "$ref": "CopyPasteRequest"
- },
- "insertDimension": {
- "$ref": "InsertDimensionRequest",
- "description": "Inserts new rows or columns in a sheet."
- },
- "deleteRange": {
- "description": "Deletes a range of cells from a sheet, shifting the remaining cells.",
- "$ref": "DeleteRangeRequest"
- },
- "deleteBanding": {
- "description": "Removes a banded range",
- "$ref": "DeleteBandingRequest"
- },
- "addFilterView": {
- "$ref": "AddFilterViewRequest",
- "description": "Adds a filter view."
- },
- "updateBorders": {
- "description": "Updates the borders in a range of cells.",
- "$ref": "UpdateBordersRequest"
- },
- "setDataValidation": {
- "$ref": "SetDataValidationRequest",
- "description": "Sets data validation for one or more cells."
- },
- "deleteConditionalFormatRule": {
- "$ref": "DeleteConditionalFormatRuleRequest",
- "description": "Deletes an existing conditional format rule."
- },
- "clearBasicFilter": {
- "$ref": "ClearBasicFilterRequest",
- "description": "Clears the basic filter on a sheet."
- },
- "repeatCell": {
- "description": "Repeats a single cell across a range.",
- "$ref": "RepeatCellRequest"
- },
- "appendDimension": {
- "$ref": "AppendDimensionRequest",
- "description": "Appends dimensions to the end of a sheet."
- },
"updateConditionalFormatRule": {
- "$ref": "UpdateConditionalFormatRuleRequest",
- "description": "Updates an existing conditional format rule."
+ "description": "Updates an existing conditional format rule.",
+ "$ref": "UpdateConditionalFormatRuleRequest"
},
"insertRange": {
"description": "Inserts new cells in a sheet, shifting the existing cells.",
"$ref": "InsertRangeRequest"
},
"moveDimension": {
- "description": "Moves rows or columns to another location in a sheet.",
- "$ref": "MoveDimensionRequest"
+ "$ref": "MoveDimensionRequest",
+ "description": "Moves rows or columns to another location in a sheet."
},
"randomizeRange": {
- "$ref": "RandomizeRangeRequest",
- "description": "Randomizes the order of the rows in a range."
+ "description": "Randomizes the order of the rows in a range.",
+ "$ref": "RandomizeRangeRequest"
},
"updateBanding": {
- "description": "Updates a banded range",
- "$ref": "UpdateBandingRequest"
+ "$ref": "UpdateBandingRequest",
+ "description": "Updates a banded range"
},
"deleteNamedRange": {
"$ref": "DeleteNamedRangeRequest",
"description": "Deletes a named range."
},
"addProtectedRange": {
- "description": "Adds a protected range.",
- "$ref": "AddProtectedRangeRequest"
+ "$ref": "AddProtectedRangeRequest",
+ "description": "Adds a protected range."
},
"duplicateSheet": {
"$ref": "DuplicateSheetRequest",
@@ -3518,29 +3487,164 @@
"description": "Updates dimensions' properties."
},
"pasteData": {
- "$ref": "PasteDataRequest",
- "description": "Pastes data (HTML or delimited) into a sheet."
+ "description": "Pastes data (HTML or delimited) into a sheet.",
+ "$ref": "PasteDataRequest"
},
"setBasicFilter": {
- "$ref": "SetBasicFilterRequest",
- "description": "Sets the basic filter on a sheet."
+ "description": "Sets the basic filter on a sheet.",
+ "$ref": "SetBasicFilterRequest"
},
"addConditionalFormatRule": {
"$ref": "AddConditionalFormatRuleRequest",
"description": "Adds a new conditional format rule."
+ },
+ "addNamedRange": {
+ "$ref": "AddNamedRangeRequest",
+ "description": "Adds a named range."
+ },
+ "updateCells": {
+ "description": "Updates many cells at once.",
+ "$ref": "UpdateCellsRequest"
+ },
+ "updateSpreadsheetProperties": {
+ "$ref": "UpdateSpreadsheetPropertiesRequest",
+ "description": "Updates the spreadsheet's properties."
+ },
+ "deleteEmbeddedObject": {
+ "$ref": "DeleteEmbeddedObjectRequest",
+ "description": "Deletes an embedded object (e.g, chart, image) in a sheet."
+ },
+ "updateFilterView": {
+ "description": "Updates the properties of a filter view.",
+ "$ref": "UpdateFilterViewRequest"
+ },
+ "addBanding": {
+ "$ref": "AddBandingRequest",
+ "description": "Adds a new banded range"
+ },
+ "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."
+ },
+ "cutPaste": {
+ "$ref": "CutPasteRequest",
+ "description": "Cuts data from one area and pastes it to another."
+ },
+ "mergeCells": {
+ "description": "Merges cells together.",
+ "$ref": "MergeCellsRequest"
+ },
+ "updateNamedRange": {
+ "$ref": "UpdateNamedRangeRequest",
+ "description": "Updates a named range."
+ },
+ "updateSheetProperties": {
+ "$ref": "UpdateSheetPropertiesRequest",
+ "description": "Updates a sheet's properties."
+ },
+ "autoFill": {
+ "$ref": "AutoFillRequest",
+ "description": "Automatically fills in more data based on existing data."
+ },
+ "deleteDimension": {
+ "$ref": "DeleteDimensionRequest",
+ "description": "Deletes rows or columns in a sheet."
+ },
+ "sortRange": {
+ "description": "Sorts data in a range.",
+ "$ref": "SortRangeRequest"
+ },
+ "deleteProtectedRange": {
+ "$ref": "DeleteProtectedRangeRequest",
+ "description": "Deletes a protected range."
+ },
+ "duplicateFilterView": {
+ "$ref": "DuplicateFilterViewRequest",
+ "description": "Duplicates a filter view."
+ },
+ "addChart": {
+ "description": "Adds a chart.",
+ "$ref": "AddChartRequest"
+ },
+ "findReplace": {
+ "description": "Finds and replaces occurrences of some text with other text.",
+ "$ref": "FindReplaceRequest"
+ },
+ "textToColumns": {
+ "$ref": "TextToColumnsRequest",
+ "description": "Converts a column of text into many columns of text."
+ },
+ "updateChartSpec": {
+ "description": "Updates a chart's specifications.",
+ "$ref": "UpdateChartSpecRequest"
+ },
+ "addSheet": {
+ "$ref": "AddSheetRequest",
+ "description": "Adds a sheet."
+ },
+ "updateProtectedRange": {
+ "description": "Updates a protected range.",
+ "$ref": "UpdateProtectedRangeRequest"
+ },
+ "copyPaste": {
+ "$ref": "CopyPasteRequest",
+ "description": "Copies data from one area and pastes it to another."
+ },
+ "deleteFilterView": {
+ "$ref": "DeleteFilterViewRequest",
+ "description": "Deletes a filter view from a sheet."
+ },
+ "insertDimension": {
+ "$ref": "InsertDimensionRequest",
+ "description": "Inserts new rows or columns in a sheet."
+ },
+ "deleteRange": {
+ "description": "Deletes a range of cells from a sheet, shifting the remaining cells.",
+ "$ref": "DeleteRangeRequest"
+ },
+ "deleteBanding": {
+ "$ref": "DeleteBandingRequest",
+ "description": "Removes a banded range"
+ },
+ "addFilterView": {
+ "description": "Adds a filter view.",
+ "$ref": "AddFilterViewRequest"
+ },
+ "updateBorders": {
+ "$ref": "UpdateBordersRequest",
+ "description": "Updates the borders in a range of cells."
+ },
+ "setDataValidation": {
+ "description": "Sets data validation for one or more cells.",
+ "$ref": "SetDataValidationRequest"
+ },
+ "deleteConditionalFormatRule": {
+ "$ref": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes an existing conditional format rule."
+ },
+ "clearBasicFilter": {
+ "$ref": "ClearBasicFilterRequest",
+ "description": "Clears the basic filter on a sheet."
+ },
+ "repeatCell": {
+ "description": "Repeats a single cell across a range.",
+ "$ref": "RepeatCellRequest"
+ },
+ "appendDimension": {
+ "description": "Appends dimensions to the end of a sheet.",
+ "$ref": "AppendDimensionRequest"
}
- }
+ },
+ "id": "Request"
},
"GridRange": {
- "id": "GridRange",
"description": "A range on a sheet.\nAll indexes are zero-based.\nIndexes are half open, e.g the start index is inclusive\nand the end index is exclusive -- [start_index, end_index).\nMissing indexes indicate the range is unbounded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `Sheet1!A1:A1 == sheet_id: 0,\n start_row_index: 0, end_row_index: 1,\n start_column_index: 0, end_column_index: 1`\n\n `Sheet1!A3:B4 == sheet_id: 0,\n start_row_index: 2, end_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A:B == sheet_id: 0,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A5:B == sheet_id: 0,\n start_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1 == sheet_id:0`\n\nThe start index must always be less than or equal to the end index.\nIf the start index equals the end index, then the range is empty.\nEmpty ranges are typically not meaningful and are usually rendered in the\nUI as `#REF!`.",
"type": "object",
"properties": {
- "startRowIndex": {
- "format": "int32",
- "description": "The start row (inclusive) of the range, or not set if unbounded.",
- "type": "integer"
- },
"startColumnIndex": {
"format": "int32",
"description": "The start column (inclusive) of the range, or not set if unbounded.",
@@ -3560,13 +3664,39 @@
"format": "int32",
"description": "The end row (exclusive) of the range, or not set if unbounded.",
"type": "integer"
+ },
+ "startRowIndex": {
+ "format": "int32",
+ "description": "The start row (inclusive) of the range, or not set if unbounded.",
+ "type": "integer"
}
- }
+ },
+ "id": "GridRange"
},
"BasicChartSpec": {
"description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
"type": "object",
"properties": {
+ "legendPosition": {
+ "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."
+ ],
+ "enum": [
+ "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND"
+ ],
+ "description": "The position of the chart legend."
+ },
"domains": {
"description": "The domain of data this is charting.\nOnly a single domain is supported.",
"items": {
@@ -3584,6 +3714,7 @@
"type": "integer"
},
"stackedType": {
+ "type": "string",
"enumDescriptions": [
"Default value, do not use.",
"Series are not stacked.",
@@ -3596,8 +3727,7 @@
"STACKED",
"PERCENT_STACKED"
],
- "description": "The stacked type for charts that support vertical stacking.\nApplies to Area, Bar, Column, and Stepped Area charts.",
- "type": "string"
+ "description": "The stacked type for charts that support vertical stacking.\nApplies to Area, Bar, Column, and Stepped Area charts."
},
"threeDimensional": {
"description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
@@ -3610,7 +3740,21 @@
},
"type": "array"
},
+ "interpolateNulls": {
+ "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missing). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Combo charts.",
+ "type": "boolean"
+ },
"chartType": {
+ "enum": [
+ "BASIC_CHART_TYPE_UNSPECIFIED",
+ "BAR",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "SCATTER",
+ "COMBO",
+ "STEPPED_AREA"
+ ],
"description": "The type of the chart.",
"type": "string",
"enumDescriptions": [
@@ -3622,81 +3766,46 @@
"A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter chart\u003c/a\u003e.",
"A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e.",
"A \u003ca href=\"/chart/interactive/docs/gallery/steppedareachart\"\u003estepped area chart\u003c/a\u003e."
- ],
- "enum": [
- "BASIC_CHART_TYPE_UNSPECIFIED",
- "BAR",
- "LINE",
- "AREA",
- "COLUMN",
- "SCATTER",
- "COMBO",
- "STEPPED_AREA"
]
},
- "interpolateNulls": {
- "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missing). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Combo charts.",
- "type": "boolean"
- },
"series": {
"description": "The data this chart is visualizing.",
"items": {
"$ref": "BasicChartSeries"
},
"type": "array"
- },
- "legendPosition": {
- "description": "The position of the chart legend.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered."
- ],
- "enum": [
- "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND"
- ]
}
},
"id": "BasicChartSpec"
},
- "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."
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range the data validation rule should apply to."
- }
- },
- "id": "SetDataValidationRequest"
- },
"BubbleChartSpec": {
"description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
"type": "object",
"properties": {
+ "groupIds": {
+ "$ref": "ChartData",
+ "description": "The data containing the bubble group IDs. All bubbles with the same group\nID will be drawn in the same color. If bubble_sizes is specified then\nthis field must also be specified but may contain blank values.\nThis field is optional."
+ },
+ "bubbleLabels": {
+ "description": "The data containing the bubble labels. These do not need to be unique.",
+ "$ref": "ChartData"
+ },
+ "bubbleMinRadiusSize": {
+ "format": "int32",
+ "description": "The minimum radius size of the bubbles, in pixels.\nIf specific, the field must be a positive value.",
+ "type": "integer"
+ },
"bubbleMaxRadiusSize": {
"format": "int32",
"description": "The max radius size of the bubbles, in pixels.\nIf specified, the field must be a positive value.",
"type": "integer"
},
"series": {
- "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically.",
- "$ref": "ChartData"
+ "$ref": "ChartData",
+ "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically."
},
"legendPosition": {
+ "type": "string",
"enumDescriptions": [
"Default value, do not use.",
"The legend is rendered on the bottom of the chart.",
@@ -3715,12 +3824,11 @@
"NO_LEGEND",
"INSIDE_LEGEND"
],
- "description": "Where the legend of the chart should be drawn.",
- "type": "string"
+ "description": "Where the legend of the chart should be drawn."
},
"domain": {
- "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally.",
- "$ref": "ChartData"
+ "$ref": "ChartData",
+ "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally."
},
"bubbleSizes": {
"description": "The data contianing the bubble sizes. Bubble sizes are used to draw\nthe bubbles at different sizes relative to each other.\nIf specified, group_ids must also be specified. This field is\noptional.",
@@ -3732,61 +3840,38 @@
"type": "number"
},
"bubbleBorderColor": {
- "description": "The bubble border color.",
- "$ref": "Color"
+ "$ref": "Color",
+ "description": "The bubble border color."
},
"bubbleTextStyle": {
- "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported.",
- "$ref": "TextFormat"
- },
- "groupIds": {
- "description": "The data containing the bubble group IDs. All bubbles with the same group\nID will be drawn in the same color. If bubble_sizes is specified then\nthis field must also be specified but may contain blank values.\nThis field is optional.",
- "$ref": "ChartData"
- },
- "bubbleLabels": {
- "$ref": "ChartData",
- "description": "The data containing the bubble labels. These do not need to be unique."
- },
- "bubbleMinRadiusSize": {
- "format": "int32",
- "description": "The minimum radius size of the bubbles, in pixels.\nIf specific, the field must be a positive value.",
- "type": "integer"
+ "$ref": "TextFormat",
+ "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported."
}
},
"id": "BubbleChartSpec"
},
+ "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."
+ },
+ "range": {
+ "description": "The range the data validation rule should apply to.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "SetDataValidationRequest"
+ },
"CellData": {
- "id": "CellData",
"description": "Data about a specific cell.",
"type": "object",
"properties": {
- "pivotTable": {
- "$ref": "PivotTable",
- "description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields."
- },
- "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"
- },
- "note": {
- "description": "Any note on the cell.",
- "type": "string"
- },
- "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"
- },
- "userEnteredValue": {
- "$ref": "ExtendedValue",
- "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format."
- },
- "dataValidation": {
- "description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule.",
- "$ref": "DataValidationRule"
- },
"effectiveValue": {
- "description": "The effective value of the cell. For cells with formulas, this will be\nthe calculated value. For cells with literals, this will be\nthe same as the user_entered_value.\nThis field is read-only.",
- "$ref": "ExtendedValue"
+ "$ref": "ExtendedValue",
+ "description": "The effective value of the cell. For cells with formulas, this will be\nthe calculated value. For cells with literals, this will be\nthe same as the user_entered_value.\nThis field is read-only."
},
"textFormatRuns": {
"description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs will be erased.",
@@ -3802,40 +3887,64 @@
"hyperlink": {
"description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnteredValue.formulaValue\nfield.)",
"type": "string"
+ },
+ "pivotTable": {
+ "$ref": "PivotTable",
+ "description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields."
+ },
+ "userEnteredFormat": {
+ "$ref": "CellFormat",
+ "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format."
+ },
+ "note": {
+ "description": "Any note on the cell.",
+ "type": "string"
+ },
+ "effectiveFormat": {
+ "$ref": "CellFormat",
+ "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only."
+ },
+ "dataValidation": {
+ "$ref": "DataValidationRule",
+ "description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule."
+ },
+ "userEnteredValue": {
+ "$ref": "ExtendedValue",
+ "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format."
}
- }
+ },
+ "id": "CellData"
},
"BatchUpdateSpreadsheetRequest": {
- "id": "BatchUpdateSpreadsheetRequest",
"description": "The request for updating any aspect of a spreadsheet.",
"type": "object",
"properties": {
- "requests": {
- "description": "A list of updates to apply to the spreadsheet.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied.",
- "items": {
- "$ref": "Request"
- },
- "type": "array"
- },
"responseIncludeGridData": {
"description": "True if grid data should be returned. Meaningful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is ignored if a field mask was set in the request.",
"type": "boolean"
},
"responseRanges": {
- "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'."
},
"includeSpreadsheetInResponse": {
"description": "Determines if the update response should include the spreadsheet\nresource.",
"type": "boolean"
+ },
+ "requests": {
+ "items": {
+ "$ref": "Request"
+ },
+ "type": "array",
+ "description": "A list of updates to apply to the spreadsheet.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied."
}
- }
+ },
+ "id": "BatchUpdateSpreadsheetRequest"
},
"Padding": {
- "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
"type": "object",
"properties": {
"top": {
@@ -3859,7 +3968,8 @@
"type": "integer"
}
},
- "id": "Padding"
+ "id": "Padding",
+ "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified."
},
"BasicChartAxis": {
"description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
@@ -3874,6 +3984,12 @@
"type": "string"
},
"position": {
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
"description": "The position of this axis.",
"type": "string",
"enumDescriptions": [
@@ -3881,18 +3997,13 @@
"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": "BasicChartAxis"
},
"DeleteDimensionRequest": {
+ "id": "DeleteDimensionRequest",
"description": "Deletes the dimensions from the sheet.",
"type": "object",
"properties": {
@@ -3900,8 +4011,7 @@
"description": "The dimensions to delete from the sheet.",
"$ref": "DimensionRange"
}
- },
- "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.)",
@@ -3913,649 +4023,539 @@
"type": "integer"
},
"spec": {
- "description": "The specification to apply to the chart.",
- "$ref": "ChartSpec"
+ "$ref": "ChartSpec",
+ "description": "The specification to apply to the chart."
}
},
"id": "UpdateChartSpecRequest"
+ },
+ "DeleteFilterViewRequest": {
+ "id": "DeleteFilterViewRequest",
+ "description": "Deletes a particular filter view.",
+ "type": "object",
+ "properties": {
+ "filterId": {
+ "format": "int32",
+ "description": "The ID of the filter to delete.",
+ "type": "integer"
+ }
+ }
+ },
+ "BatchUpdateValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "totalUpdatedColumns": {
+ "format": "int32",
+ "description": "The total number of columns where at least one cell in the column was\nupdated.",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "totalUpdatedRows": {
+ "format": "int32",
+ "description": "The total number of rows where at least one cell in the row was updated.",
+ "type": "integer"
+ },
+ "responses": {
+ "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared.",
+ "items": {
+ "$ref": "UpdateValuesResponse"
+ },
+ "type": "array"
+ },
+ "totalUpdatedSheets": {
+ "format": "int32",
+ "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
+ "type": "integer"
+ },
+ "totalUpdatedCells": {
+ "format": "int32",
+ "description": "The total number of cells updated.",
+ "type": "integer"
+ }
+ },
+ "id": "BatchUpdateValuesResponse"
+ },
+ "SortRangeRequest": {
+ "description": "Sorts data in rows based on a sort order per column.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to sort."
+ },
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "items": {
+ "$ref": "SortSpec"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SortRangeRequest"
+ },
+ "MergeCellsRequest": {
+ "description": "Merges all cells in the range.",
+ "type": "object",
+ "properties": {
+ "mergeType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Create a single merge from the range",
+ "Create a merge for each column in the range",
+ "Create a merge for each row in the range"
+ ],
+ "enum": [
+ "MERGE_ALL",
+ "MERGE_COLUMNS",
+ "MERGE_ROWS"
+ ],
+ "description": "How the cells should be merged."
+ },
+ "range": {
+ "description": "The range of cells to merge.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "MergeCellsRequest"
+ },
+ "AddProtectedRangeRequest": {
+ "description": "Adds a new protected range.",
+ "type": "object",
+ "properties": {
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)"
+ }
+ },
+ "id": "AddProtectedRangeRequest"
+ },
+ "BatchClearValuesRequest": {
+ "properties": {
+ "ranges": {
+ "description": "The ranges to clear, in A1 notation.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchClearValuesRequest",
+ "description": "The request for clearing more than one range of values in a spreadsheet.",
+ "type": "object"
+ },
+ "DuplicateFilterViewResponse": {
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The newly created filter."
+ }
+ },
+ "id": "DuplicateFilterViewResponse",
+ "description": "The result of a filter view being duplicated.",
+ "type": "object"
+ },
+ "DuplicateSheetResponse": {
+ "description": "The result of duplicating a sheet.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "The properties of the duplicate sheet.",
+ "$ref": "SheetProperties"
+ }
+ },
+ "id": "DuplicateSheetResponse"
+ },
+ "ClearBasicFilterRequest": {
+ "description": "Clears the basic filter, if any exists on the sheet.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "format": "int32",
+ "description": "The sheet ID on which the basic filter should be cleared.",
+ "type": "integer"
+ }
+ },
+ "id": "ClearBasicFilterRequest"
+ },
+ "TextToColumnsRequest": {
+ "type": "object",
+ "properties": {
+ "delimiterType": {
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "\",\"",
+ "\";\"",
+ "\".\"",
+ "\" \"",
+ "A custom value as defined in delimiter."
+ ],
+ "enum": [
+ "DELIMITER_TYPE_UNSPECIFIED",
+ "COMMA",
+ "SEMICOLON",
+ "PERIOD",
+ "SPACE",
+ "CUSTOM"
+ ],
+ "description": "The delimiter type to use.",
+ "type": "string"
+ },
+ "source": {
+ "$ref": "GridRange",
+ "description": "The source data range. This must span exactly one column."
+ },
+ "delimiter": {
+ "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
+ "type": "string"
+ }
+ },
+ "id": "TextToColumnsRequest",
+ "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell."
+ },
+ "DeleteBandingRequest": {
+ "type": "object",
+ "properties": {
+ "bandedRangeId": {
+ "format": "int32",
+ "description": "The ID of the banded range to delete.",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteBandingRequest",
+ "description": "Removes the banded range with the given ID from the spreadsheet."
+ },
+ "BatchUpdateSpreadsheetResponse": {
+ "type": "object",
+ "properties": {
+ "updatedSpreadsheet": {
+ "$ref": "Spreadsheet",
+ "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
+ },
+ "replies": {
+ "items": {
+ "$ref": "Response"
+ },
+ "type": "array",
+ "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty."
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "id": "BatchUpdateSpreadsheetResponse",
+ "description": "The reply for batch updating a spreadsheet."
+ },
+ "AppendValuesResponse": {
+ "id": "AppendValuesResponse",
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "updates": {
+ "$ref": "UpdateValuesResponse",
+ "description": "Information about the updates that were applied."
+ },
+ "tableRange": {
+ "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.",
+ "type": "string"
+ },
+ "spreadsheetId": {
+ "type": "string",
+ "description": "The spreadsheet the updates were applied to."
+ }
+ }
+ },
+ "AddFilterViewRequest": {
+ "description": "Adds a filter view.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)"
+ }
+ },
+ "id": "AddFilterViewRequest"
+ },
+ "PivotFilterCriteria": {
+ "description": "Criteria for showing/hiding rows in a pivot table.",
+ "type": "object",
+ "properties": {
+ "visibleValues": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Values that should be included. Values not listed here are excluded."
+ }
+ },
+ "id": "PivotFilterCriteria"
+ },
+ "MoveDimensionRequest": {
+ "type": "object",
+ "properties": {
+ "destinationIndex": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`."
+ },
+ "source": {
+ "$ref": "DimensionRange",
+ "description": "The source dimensions to move."
+ }
+ },
+ "id": "MoveDimensionRequest",
+ "description": "Moves one or more rows or columns."
+ },
+ "AddConditionalFormatRuleRequest": {
+ "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
+ "type": "object",
+ "properties": {
+ "rule": {
+ "description": "The rule to add.",
+ "$ref": "ConditionalFormatRule"
+ },
+ "index": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The zero-based index where the rule should be inserted."
+ }
+ },
+ "id": "AddConditionalFormatRuleRequest"
+ },
+ "ChartSpec": {
+ "type": "object",
+ "properties": {
+ "maximized": {
+ "description": "True to make a chart fill the entire space in which it's rendered with\nminimum padding. False to use the default padding.\n(Not applicable to Geo and Org charts.)",
+ "type": "boolean"
+ },
+ "hiddenDimensionStrategy": {
+ "enum": [
+ "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
+ "SKIP_HIDDEN_ROWS_AND_COLUMNS",
+ "SKIP_HIDDEN_ROWS",
+ "SKIP_HIDDEN_COLUMNS",
+ "SHOW_ALL"
+ ],
+ "description": "Determines how the charts will use hidden rows or columns.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Charts will skip hidden rows and columns.",
+ "Charts will skip hidden rows only.",
+ "Charts will skip hidden columns only.",
+ "Charts will not skip any hidden rows or columns."
+ ]
+ },
+ "backgroundColor": {
+ "$ref": "Color",
+ "description": "The background color of the entire chart.\nNot applicable to Org charts."
+ },
+ "basicChart": {
+ "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports.",
+ "$ref": "BasicChartSpec"
+ },
+ "orgChart": {
+ "$ref": "OrgChartSpec",
+ "description": "An org chart specification."
+ },
+ "pieChart": {
+ "$ref": "PieChartSpec",
+ "description": "A pie chart specification."
+ },
+ "titleTextFormat": {
+ "$ref": "TextFormat",
+ "description": "The title text format.\nStrikethrough and underline are not supported."
+ },
+ "title": {
+ "description": "The title of the chart.",
+ "type": "string"
+ },
+ "altText": {
+ "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
+ "type": "string"
+ },
+ "histogramChart": {
+ "description": "A histogram chart specification.",
+ "$ref": "HistogramChartSpec"
+ },
+ "candlestickChart": {
+ "$ref": "CandlestickChartSpec",
+ "description": "A candlestick chart specification."
+ },
+ "bubbleChart": {
+ "$ref": "BubbleChartSpec",
+ "description": "A bubble chart specification."
+ },
+ "fontName": {
+ "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.",
+ "type": "string"
+ }
+ },
+ "id": "ChartSpec",
+ "description": "The specifications of a chart."
+ },
+ "NumberFormat": {
+ "description": "The number format of a cell.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
+ "Text formatting, e.g `1000.12`",
+ "Number formatting, e.g, `1,000.12`",
+ "Percent formatting, e.g `10.12%`",
+ "Currency formatting, e.g `$1,000.12`",
+ "Date formatting, e.g `9/26/2008`",
+ "Time formatting, e.g `3:59:00 PM`",
+ "Date+Time formatting, e.g `9/26/08 15:59:00`",
+ "Scientific number formatting, e.g `1.01E+03`"
+ ],
+ "enum": [
+ "NUMBER_FORMAT_TYPE_UNSPECIFIED",
+ "TEXT",
+ "NUMBER",
+ "PERCENT",
+ "CURRENCY",
+ "DATE",
+ "TIME",
+ "DATE_TIME",
+ "SCIENTIFIC"
+ ],
+ "description": "The type of the number format.\nWhen writing, this field must be set.",
+ "type": "string"
+ },
+ "pattern": {
+ "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for more\ninformation about the supported patterns.",
+ "type": "string"
+ }
+ },
+ "id": "NumberFormat"
+ },
+ "CandlestickDomain": {
+ "description": "The domain of a CandlestickChart.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "The data of the CandlestickDomain.",
+ "$ref": "ChartData"
+ },
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ }
+ },
+ "id": "CandlestickDomain"
+ },
+ "SheetProperties": {
+ "description": "Properties of a sheet.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "The name of the sheet.",
+ "type": "string"
+ },
+ "tabColor": {
+ "$ref": "Color",
+ "description": "The color of the tab in the UI."
+ },
+ "index": {
+ "format": "int32",
+ "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
+ "type": "integer"
+ },
+ "sheetId": {
+ "format": "int32",
+ "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
+ "type": "integer"
+ },
+ "rightToLeft": {
+ "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
+ "type": "boolean"
+ },
+ "hidden": {
+ "description": "True if the sheet is hidden in the UI, false if it's visible.",
+ "type": "boolean"
+ },
+ "gridProperties": {
+ "$ref": "GridProperties",
+ "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets."
+ },
+ "sheetType": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The sheet is a grid.",
+ "The sheet has no grid and instead has an object like a chart or image."
+ ],
+ "enum": [
+ "SHEET_TYPE_UNSPECIFIED",
+ "GRID",
+ "OBJECT"
+ ],
+ "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
+ "type": "string"
+ }
+ },
+ "id": "SheetProperties"
+ },
+ "UpdateDimensionPropertiesRequest": {
+ "description": "Updates properties of dimensions within the specified range.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The rows or columns to update."
+ },
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "DimensionProperties",
+ "description": "Properties to update."
+ }
+ },
+ "id": "UpdateDimensionPropertiesRequest"
+ },
+ "SourceAndDestination": {
+ "description": "A combination of a source range and how to extend that source.",
+ "type": "object",
+ "properties": {
+ "fillLength": {
+ "format": "int32",
+ "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
+ "type": "integer"
+ },
+ "source": {
+ "description": "The location of the data to use as the source of the autofill.",
+ "$ref": "GridRange"
+ },
+ "dimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension that data should be filled into.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
+ }
+ },
+ "id": "SourceAndDestination"
}
},
+ "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": "Sheets",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/drive.file": {
- "description": "View and manage Google Drive files and folders that you have opened or created with this app"
- },
- "https://www.googleapis.com/auth/spreadsheets.readonly": {
- "description": "View your Google Spreadsheets"
- },
- "https://www.googleapis.com/auth/drive.readonly": {
- "description": "View the files in your Google Drive"
- },
- "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"
- }
- }
- }
- },
- "rootUrl": "https://sheets.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "sheets",
- "batchPath": "batch",
- "title": "Google Sheets API",
- "ownerName": "Google",
- "resources": {
- "spreadsheets": {
- "methods": {
- "get": {
- "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation.",
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "includeGridData": {
- "location": "query",
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean"
- },
- "ranges": {
- "description": "The ranges to retrieve from the spreadsheet.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "spreadsheetId": {
- "description": "The spreadsheet to request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}",
- "id": "sheets.spreadsheets.get",
- "path": "v4/spreadsheets/{spreadsheetId}"
- },
- "batchUpdate": {
- "response": {
- "$ref": "BatchUpdateSpreadsheetResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "description": "The spreadsheet to apply the updates to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "id": "sheets.spreadsheets.batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "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."
- },
- "create": {
- "request": {
- "$ref": "Spreadsheet"
- },
- "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Spreadsheet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {},
- "flatPath": "v4/spreadsheets",
- "path": "v4/spreadsheets",
- "id": "sheets.spreadsheets.create"
- }
- },
- "resources": {
- "values": {
- "methods": {
- "clear": {
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
- "id": "sheets.spreadsheets.values.clear",
- "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "request": {
- "$ref": "ClearValuesRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "ClearValuesResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "type": "string",
- "required": true
- },
- "range": {
- "description": "The A1 notation of the values to clear.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear"
- },
- "batchGet": {
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchGetValuesResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve data from.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "dateTimeRenderOption": {
- "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string",
- "location": "query",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ]
- },
- "valueRenderOption": {
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
- },
- "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"
- ]
- },
- "ranges": {
- "repeated": true,
- "location": "query",
- "description": "The A1 notation of the values to retrieve.",
- "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."
- },
- "append": {
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "type": "string",
- "required": true
- },
- "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"
- },
- "valueInputOption": {
- "location": "query",
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string"
- },
- "responseDateTimeRenderOption": {
- "location": "query",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string"
- },
- "range": {
- "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "includeValuesInResponse": {
- "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"
- }
- },
- "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",
- "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.",
- "request": {
- "$ref": "ValueRange"
- },
- "response": {
- "$ref": "AppendValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "POST"
- },
- "batchClear": {
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchClearValuesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "id": "sheets.spreadsheets.values.batchClear",
- "request": {
- "$ref": "BatchClearValuesRequest"
- },
- "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept."
- },
- "get": {
- "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
- "response": {
- "$ref": "ValueRange"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve data from.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "range": {
- "location": "path",
- "description": "The A1 notation of the values to retrieve.",
- "type": "string",
- "required": true
- },
- "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"
- ]
- },
- "valueRenderOption": {
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
- },
- "majorDimension": {
- "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"
- ]
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.get",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}"
- },
- "update": {
- "parameters": {
- "responseDateTimeRenderOption": {
- "location": "query",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string"
- },
- "includeValuesInResponse": {
- "location": "query",
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
- "type": "boolean"
- },
- "range": {
- "description": "The A1 notation of the values to update.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "type": "string",
- "required": true
- },
- "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"
- ]
- }
- },
- "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}",
- "id": "sheets.spreadsheets.values.update",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
- "request": {
- "$ref": "ValueRange"
- },
- "response": {
- "$ref": "UpdateValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "PUT"
- },
- "batchUpdate": {
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchUpdateValuesResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "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"
- }
- }
- }
- },
- "sheets": {
- "methods": {
- "copyTo": {
- "response": {
- "$ref": "SheetProperties"
- },
- "parameterOrder": [
- "spreadsheetId",
- "sheetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet containing the sheet to copy.",
- "type": "string",
- "required": true
- },
- "sheetId": {
- "location": "path",
- "format": "int32",
- "description": "The ID of the sheet to copy.",
- "type": "integer",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "id": "sheets.spreadsheets.sheets.copyTo",
- "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
- "request": {
- "$ref": "CopySheetToAnotherSpreadsheetRequest"
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "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"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- }
- },
- "version": "v4",
- "baseUrl": "https://sheets.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Reads and writes Google Sheets.",
- "basePath": ""
+ }
}
diff --git a/slides/v1/slides-api.json b/slides/v1/slides-api.json
index 81b6a26..0089436 100644
--- a/slides/v1/slides-api.json
+++ b/slides/v1/slides-api.json
@@ -1,64 +1,2256 @@
{
+ "canonicalName": "Slides",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/presentations.readonly": {
+ "description": "View your Google Slides presentations"
+ },
+ "https://www.googleapis.com/auth/spreadsheets.readonly": {
+ "description": "View your Google Spreadsheets"
+ },
+ "https://www.googleapis.com/auth/drive": {
+ "description": "View and manage the files in your Google Drive"
+ },
+ "https://www.googleapis.com/auth/drive.readonly": {
+ "description": "View the files in your Google Drive"
+ },
+ "https://www.googleapis.com/auth/spreadsheets": {
+ "description": "View and manage your spreadsheets in Google Drive"
+ },
+ "https://www.googleapis.com/auth/presentations": {
+ "description": "View and manage your Google Slides presentations"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://slides.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "slides",
+ "batchPath": "batch",
+ "title": "Google Slides API",
+ "ownerName": "Google",
+ "resources": {
+ "presentations": {
+ "methods": {
+ "get": {
+ "flatPath": "v1/presentations/{presentationsId}",
+ "id": "slides.presentations.get",
+ "path": "v1/presentations/{+presentationId}",
+ "description": "Gets the latest version of the specified presentation.",
+ "response": {
+ "$ref": "Presentation"
+ },
+ "parameterOrder": [
+ "presentationId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "presentationId": {
+ "description": "The ID of the presentation to retrieve.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "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"
+ ]
+ },
+ "batchUpdate": {
+ "response": {
+ "$ref": "BatchUpdatePresentationResponse"
+ },
+ "parameterOrder": [
+ "presentationId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "presentationId": {
+ "location": "path",
+ "description": "The presentation to apply the updates to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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"
+ ],
+ "flatPath": "v1/presentations/{presentationId}:batchUpdate",
+ "id": "slides.presentations.batchUpdate",
+ "path": "v1/presentations/{presentationId}: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"
+ }
+ },
+ "create": {
+ "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation.",
+ "request": {
+ "$ref": "Presentation"
+ },
+ "response": {
+ "$ref": "Presentation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/presentations"
+ ],
+ "flatPath": "v1/presentations",
+ "id": "slides.presentations.create",
+ "path": "v1/presentations"
+ }
+ },
+ "resources": {
+ "pages": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Page"
+ },
+ "parameterOrder": [
+ "presentationId",
+ "pageObjectId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/presentations.readonly"
+ ],
+ "parameters": {
+ "pageObjectId": {
+ "description": "The object ID of the page to retrieve.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "presentationId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the presentation to retrieve."
+ }
+ },
+ "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}",
+ "id": "slides.presentations.pages.get",
+ "path": "v1/presentations/{presentationId}/pages/{pageObjectId}",
+ "description": "Gets the latest version of the specified page in the presentation."
+ },
+ "getThumbnail": {
+ "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.",
+ "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": {
+ "pageObjectId": {
+ "location": "path",
+ "description": "The object ID of the page whose thumbnail to retrieve.",
+ "type": "string",
+ "required": true
+ },
+ "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"
+ },
+ "thumbnailProperties.mimeType": {
+ "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",
+ "location": "query"
+ },
+ "presentationId": {
+ "location": "path",
+ "description": "The ID of the presentation to retrieve.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "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"
+ },
+ "$.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": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://slides.googleapis.com/",
+ "servicePath": "",
+ "description": "An API for creating and editing Google Slides presentations.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
"revision": "20170816",
"documentationLink": "https://developers.google.com/slides/",
"id": "slides:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "UpdateParagraphStyleRequest": {
- "description": "Updates the styling for all of the paragraphs within a Shape or Table that\noverlap with the given text index range.",
+ "InsertTableRowsRequest": {
+ "description": "Inserts rows into a table.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "format": "int32",
+ "description": "The number of rows to be inserted. Maximum 20 per request.",
+ "type": "integer"
+ },
+ "cellLocation": {
+ "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell.",
+ "$ref": "TableCellLocation"
+ },
+ "tableObjectId": {
+ "description": "The table to insert rows into.",
+ "type": "string"
+ },
+ "insertBelow": {
+ "description": "Whether to insert new rows below the reference cell location.\n\n- `True`: insert below the cell.\n- `False`: insert above the cell.",
+ "type": "boolean"
+ }
+ },
+ "id": "InsertTableRowsRequest"
+ },
+ "LayoutProperties": {
+ "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT.",
+ "type": "object",
+ "properties": {
+ "masterObjectId": {
+ "description": "The object ID of the master that this layout is based on.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the layout.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The human-readable name of the layout.",
+ "type": "string"
+ }
+ },
+ "id": "LayoutProperties"
+ },
+ "Presentation": {
+ "type": "object",
+ "properties": {
+ "slides": {
+ "description": "The slides in the presentation.\nA slide inherits properties from a slide layout.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
+ },
+ "revisionId": {
+ "type": "string",
+ "description": "The revision ID of the presentation. Can be used in update requests\nto assert that the presentation revision hasn't changed since the last\nread operation. Only populated if the user has edit access to the\npresentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. 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."
+ },
+ "notesMaster": {
+ "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.",
+ "$ref": "Page"
+ },
+ "layouts": {
+ "description": "The layouts in the presentation. A layout is a template that determines\nhow content is arranged and styled on the slides that inherit from that\nlayout.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
+ },
+ "title": {
+ "description": "The title of the presentation.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale of the presentation, as an IETF BCP 47 language tag.",
+ "type": "string"
+ },
+ "masters": {
+ "description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
+ },
+ "pageSize": {
+ "description": "The size of pages in the presentation.",
+ "$ref": "Size"
+ },
+ "presentationId": {
+ "description": "The ID of the presentation.",
+ "type": "string"
+ }
+ },
+ "id": "Presentation",
+ "description": "A Google Slides presentation."
+ },
+ "LineProperties": {
+ "type": "object",
+ "properties": {
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the line."
+ },
+ "lineFill": {
+ "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor.",
+ "$ref": "LineFill"
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the line. If unset, there is no link."
+ },
+ "dashStyle": {
+ "description": "The dash style of the line.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ],
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ]
+ },
+ "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"
+ ]
+ },
+ "endArrow": {
+ "description": "The style of the arrow at the end of the line.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified arrow style.",
+ "No arrow.",
+ "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
+ "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
+ "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
+ "Filled square.",
+ "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
+ "Hollow arrow.",
+ "Hollow circle.",
+ "Hollow square.",
+ "Hollow diamond."
+ ],
+ "enum": [
+ "ARROW_STYLE_UNSPECIFIED",
+ "NONE",
+ "STEALTH_ARROW",
+ "FILL_ARROW",
+ "FILL_CIRCLE",
+ "FILL_SQUARE",
+ "FILL_DIAMOND",
+ "OPEN_ARROW",
+ "OPEN_CIRCLE",
+ "OPEN_SQUARE",
+ "OPEN_DIAMOND"
+ ]
+ }
+ },
+ "id": "LineProperties",
+ "description": "The properties of the Line.\n\nWhen unset, these fields default to values that match the appearance of\nnew lines created in the Slides editor."
+ },
+ "OpaqueColor": {
+ "description": "A themeable solid color value.",
+ "type": "object",
+ "properties": {
+ "rgbColor": {
+ "$ref": "RgbColor",
+ "description": "An opaque RGB color."
+ },
+ "themeColor": {
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "DARK1",
+ "LIGHT1",
+ "DARK2",
+ "LIGHT2",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "HYPERLINK",
+ "FOLLOWED_HYPERLINK",
+ "TEXT1",
+ "BACKGROUND1",
+ "TEXT2",
+ "BACKGROUND2"
+ ],
+ "description": "An opaque theme color.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified theme color. This value should not be used.",
+ "Represents the first dark color.",
+ "Represents the first light color.",
+ "Represents the second dark color.",
+ "Represents the second light color.",
+ "Represents the first accent color.",
+ "Represents the second accent color.",
+ "Represents the third accent color.",
+ "Represents the fourth accent color.",
+ "Represents the fifth accent color.",
+ "Represents the sixth accent color.",
+ "Represents the color to use for hyperlinks.",
+ "Represents the color to use for visited hyperlinks.",
+ "Represents the first text color.",
+ "Represents the first background color.",
+ "Represents the second text color.",
+ "Represents the second background color."
+ ]
+ }
+ },
+ "id": "OpaqueColor"
+ },
+ "ImageProperties": {
+ "properties": {
+ "outline": {
+ "description": "The outline of the image. If not set, the the image has no outline.",
+ "$ref": "Outline"
+ },
+ "brightness": {
+ "format": "float",
+ "description": "The brightness effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
+ "type": "number"
+ },
+ "transparency": {
+ "type": "number",
+ "format": "float",
+ "description": "The transparency effect of the image. The value should be in the interval\n[0.0, 1.0], where 0 means no effect and 1 means completely transparent.\nThis property is read-only."
+ },
+ "shadow": {
+ "description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only.",
+ "$ref": "Shadow"
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the image. If unset, there is no link."
+ },
+ "contrast": {
+ "format": "float",
+ "description": "The contrast effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
+ "type": "number"
+ },
+ "cropProperties": {
+ "$ref": "CropProperties",
+ "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only."
+ },
+ "recolor": {
+ "$ref": "Recolor",
+ "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only."
+ }
+ },
+ "id": "ImageProperties",
+ "description": "The properties of the Image.",
+ "type": "object"
+ },
+ "ReplaceAllShapesWithImageResponse": {
+ "id": "ReplaceAllShapesWithImageResponse",
+ "description": "The result of replacing shapes with an image.",
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "format": "int32",
+ "description": "The number of shapes replaced with images.",
+ "type": "integer"
+ }
+ }
+ },
+ "Line": {
+ "id": "Line",
+ "description": "A PageElement kind representing a\nline, curved connector, or bent connector.",
+ "type": "object",
+ "properties": {
+ "lineType": {
+ "description": "The type of the line.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified line type.",
+ "Straight connector 1 form. Corresponds to ECMA-376 ST_ShapeType\n'straightConnector1'.",
+ "Bent connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector2'.",
+ "Bent connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector3'.",
+ "Bent connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector4'.",
+ "Bent connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector5'.",
+ "Curved connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector2'.",
+ "Curved connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector3'.",
+ "Curved connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector4'.",
+ "Curved connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector5'."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "STRAIGHT_CONNECTOR_1",
+ "BENT_CONNECTOR_2",
+ "BENT_CONNECTOR_3",
+ "BENT_CONNECTOR_4",
+ "BENT_CONNECTOR_5",
+ "CURVED_CONNECTOR_2",
+ "CURVED_CONNECTOR_3",
+ "CURVED_CONNECTOR_4",
+ "CURVED_CONNECTOR_5"
+ ]
+ },
+ "lineProperties": {
+ "$ref": "LineProperties",
+ "description": "The properties of the line."
+ }
+ }
+ },
+ "CreateSheetsChartRequest": {
+ "properties": {
+ "chartId": {
+ "format": "int32",
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
+ "type": "integer"
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf specified, the ID must be unique among all pages and page elements in\nthe presentation. The ID should start with a word character [a-zA-Z0-9_]\nand then followed by any number of the following characters [a-zA-Z0-9_-:].\nThe length of the ID should not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
+ "type": "string"
+ },
+ "elementProperties": {
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the chart.\n\nWhen the aspect ratio of the provided size does not match the chart aspect\nratio, the chart is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
+ },
+ "linkingMode": {
+ "enumDescriptions": [
+ "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
+ "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
+ ],
+ "enum": [
+ "NOT_LINKED_IMAGE",
+ "LINKED"
+ ],
+ "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked.",
+ "type": "string"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
+ "type": "string"
+ }
+ },
+ "id": "CreateSheetsChartRequest",
+ "description": "Creates an embedded Google Sheets chart.\n\nNOTE: Chart creation requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object"
+ },
+ "BatchUpdatePresentationResponse": {
+ "description": "Response message from a batch update.",
+ "type": "object",
+ "properties": {
+ "presentationId": {
+ "description": "The presentation the updates were applied to.",
+ "type": "string"
+ },
+ "replies": {
+ "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
+ "items": {
+ "$ref": "Response"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchUpdatePresentationResponse"
+ },
+ "CreateImageResponse": {
+ "description": "The result of creating an image.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created image.",
+ "type": "string"
+ }
+ },
+ "id": "CreateImageResponse"
+ },
+ "SlideProperties": {
+ "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "masterObjectId": {
+ "type": "string",
+ "description": "The object ID of the master that this slide is based on."
+ },
+ "layoutObjectId": {
+ "description": "The object ID of the layout that this slide is based on.",
+ "type": "string"
+ }
+ },
+ "id": "SlideProperties"
+ },
+ "MasterProperties": {
+ "description": "The properties of Page that are only\nrelevant for pages with page_type MASTER.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The human-readable name of the master.",
+ "type": "string"
+ }
+ },
+ "id": "MasterProperties"
+ },
+ "Response": {
+ "description": "A single response from an update.",
+ "type": "object",
+ "properties": {
+ "replaceAllShapesWithImage": {
+ "description": "The result of replacing all shapes matching some criteria with an\nimage.",
+ "$ref": "ReplaceAllShapesWithImageResponse"
+ },
+ "createTable": {
+ "$ref": "CreateTableResponse",
+ "description": "The result of creating a table."
+ },
+ "replaceAllText": {
+ "description": "The result of replacing text.",
+ "$ref": "ReplaceAllTextResponse"
+ },
+ "createSlide": {
+ "description": "The result of creating a slide.",
+ "$ref": "CreateSlideResponse"
+ },
+ "duplicateObject": {
+ "description": "The result of duplicating an object.",
+ "$ref": "DuplicateObjectResponse"
+ },
+ "createShape": {
+ "description": "The result of creating a shape.",
+ "$ref": "CreateShapeResponse"
+ },
+ "createLine": {
+ "description": "The result of creating a line.",
+ "$ref": "CreateLineResponse"
+ },
+ "createImage": {
+ "$ref": "CreateImageResponse",
+ "description": "The result of creating an image."
+ },
+ "createVideo": {
+ "$ref": "CreateVideoResponse",
+ "description": "The result of creating a video."
+ },
+ "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."
+ }
+ },
+ "id": "Response"
+ },
+ "SubstringMatchCriteria": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The text to search for in the shape or table.",
+ "type": "string"
+ },
+ "matchCase": {
+ "description": "Indicates whether the search should respect case:\n\n- `True`: the search is case sensitive.\n- `False`: the search is case insensitive.",
+ "type": "boolean"
+ }
+ },
+ "id": "SubstringMatchCriteria",
+ "description": "A criteria that matches a specific string of text in a shape or table."
+ },
+ "LayoutReference": {
+ "properties": {
+ "predefinedLayout": {
+ "description": "Predefined layout.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified layout.",
+ "Blank layout, with no placeholders.",
+ "Layout with a caption at the bottom.",
+ "Layout with a title and a subtitle.",
+ "Layout with a title and body.",
+ "Layout with a title and two columns.",
+ "Layout with only a title.",
+ "Layout with a section title.",
+ "Layout with a title and subtitle on one side and description on the other.",
+ "Layout with one title and one body, arranged in a single column.",
+ "Layout with a main point.",
+ "Layout with a big number heading."
+ ],
+ "enum": [
+ "PREDEFINED_LAYOUT_UNSPECIFIED",
+ "BLANK",
+ "CAPTION_ONLY",
+ "TITLE",
+ "TITLE_AND_BODY",
+ "TITLE_AND_TWO_COLUMNS",
+ "TITLE_ONLY",
+ "SECTION_HEADER",
+ "SECTION_TITLE_AND_DESCRIPTION",
+ "ONE_COLUMN_TEXT",
+ "MAIN_POINT",
+ "BIG_NUMBER"
+ ]
+ },
+ "layoutId": {
+ "description": "Layout ID: the object ID of one of the layouts in the presentation.",
+ "type": "string"
+ }
+ },
+ "id": "LayoutReference",
+ "description": "Slide layout reference. This may reference either:\n\n- A predefined layout\n- One of the layouts in the presentation.",
+ "type": "object"
+ },
+ "TextRun": {
+ "description": "A TextElement kind that represents a run of text that all has the same\nstyling.",
"type": "object",
"properties": {
"style": {
- "$ref": "ParagraphStyle",
- "description": "The paragraph's style."
+ "$ref": "TextStyle",
+ "description": "The styling applied to this run."
+ },
+ "content": {
+ "description": "The text of this run.",
+ "type": "string"
+ }
+ },
+ "id": "TextRun"
+ },
+ "TableRange": {
+ "properties": {
+ "rowSpan": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The row span of the table range."
+ },
+ "location": {
+ "$ref": "TableCellLocation",
+ "description": "The starting location of the table range."
+ },
+ "columnSpan": {
+ "format": "int32",
+ "description": "The column span of the table range.",
+ "type": "integer"
+ }
+ },
+ "id": "TableRange",
+ "description": "A table range represents a reference to a subset of a table.\n\nIt's important to note that the cells specified by a table range do not\nnecessarily form a rectangle. For example, let's say we have a 3 x 3 table\nwhere all the cells of the last row are merged together. The table looks\nlike this:\n\n \n [ ]\n\nA table range with location = (0, 0), row span = 3 and column span = 2\nspecifies the following cells:\n\n x x \n [ x ]",
+ "type": "object"
+ },
+ "CreateTableResponse": {
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created table.",
+ "type": "string"
+ }
+ },
+ "id": "CreateTableResponse",
+ "description": "The result of creating a table.",
+ "type": "object"
+ },
+ "CreateTableRequest": {
+ "id": "CreateTableRequest",
+ "description": "Creates a new table.",
+ "type": "object",
+ "properties": {
+ "rows": {
+ "format": "int32",
+ "description": "Number of rows in the table.",
+ "type": "integer"
+ },
+ "columns": {
+ "format": "int32",
+ "description": "Number of columns in the table.",
+ "type": "integer"
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ },
+ "elementProperties": {
+ "$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."
+ }
+ }
+ },
+ "Table": {
+ "description": "A PageElement kind representing a\ntable.",
+ "type": "object",
+ "properties": {
+ "rows": {
+ "format": "int32",
+ "description": "Number of rows in the table.",
+ "type": "integer"
+ },
+ "tableColumns": {
+ "description": "Properties of each column.",
+ "items": {
+ "$ref": "TableColumnProperties"
+ },
+ "type": "array"
+ },
+ "columns": {
+ "format": "int32",
+ "description": "Number of columns in the table.",
+ "type": "integer"
+ },
+ "tableRows": {
+ "description": "Properties and contents of each row.\n\nCells that span multiple rows are contained in only one of these rows and\nhave a row_span greater\nthan 1.",
+ "items": {
+ "$ref": "TableRow"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Table"
+ },
+ "PageBackgroundFill": {
+ "description": "The page 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.",
+ "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 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": {
+ "description": "Stretched picture fill.",
+ "$ref": "StretchedPictureFill"
+ }
+ },
+ "id": "PageBackgroundFill"
+ },
+ "SheetsChart": {
+ "type": "object",
+ "properties": {
+ "sheetsChartProperties": {
+ "$ref": "SheetsChartProperties",
+ "description": "The properties of the Sheets chart."
+ },
+ "contentUrl": {
+ "description": "The URL of an image of the embedded chart, with a default lifetime of 30\nminutes. This URL is tagged with the account of the requester. Anyone with\nthe URL effectively accesses the image as the original requester. Access to\nthe image may be lost if the presentation's sharing settings change.",
+ "type": "string"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the source chart.",
+ "type": "string"
+ },
+ "chartId": {
+ "format": "int32",
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.",
+ "type": "integer"
+ }
+ },
+ "id": "SheetsChart",
+ "description": "A PageElement kind representing\na linked chart embedded from Google Sheets."
+ },
+ "SolidFill": {
+ "description": "A solid color fill. The page or page element is filled entirely with the\nspecified color value.\n\nIf any field is unset, its value may be inherited from a parent placeholder\nif it exists.",
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "type": "number",
+ "format": "float",
+ "description": "The fraction of this `color` that should be applied to the pixel.\nThat is, the final pixel color is defined by the equation:\n\n pixel color = alpha * (color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color."
+ },
+ "color": {
+ "description": "The color value of the solid fill.",
+ "$ref": "OpaqueColor"
+ }
+ },
+ "id": "SolidFill"
+ },
+ "ThemeColorPair": {
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "The concrete color corresponding to the theme color type above.",
+ "$ref": "RgbColor"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unspecified theme color. This value should not be used.",
+ "Represents the first dark color.",
+ "Represents the first light color.",
+ "Represents the second dark color.",
+ "Represents the second light color.",
+ "Represents the first accent color.",
+ "Represents the second accent color.",
+ "Represents the third accent color.",
+ "Represents the fourth accent color.",
+ "Represents the fifth accent color.",
+ "Represents the sixth accent color.",
+ "Represents the color to use for hyperlinks.",
+ "Represents the color to use for visited hyperlinks.",
+ "Represents the first text color.",
+ "Represents the first background color.",
+ "Represents the second text color.",
+ "Represents the second background color."
+ ],
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "DARK1",
+ "LIGHT1",
+ "DARK2",
+ "LIGHT2",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "HYPERLINK",
+ "FOLLOWED_HYPERLINK",
+ "TEXT1",
+ "BACKGROUND1",
+ "TEXT2",
+ "BACKGROUND2"
+ ],
+ "description": "The type of the theme color.",
+ "type": "string"
+ }
+ },
+ "id": "ThemeColorPair",
+ "description": "A pair mapping a theme color type to the concrete color it represents."
+ },
+ "OptionalColor": {
+ "id": "OptionalColor",
+ "description": "A color that can either be fully opaque or fully transparent.",
+ "type": "object",
+ "properties": {
+ "opaqueColor": {
+ "$ref": "OpaqueColor",
+ "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
+ }
+ }
+ },
+ "PageElementProperties": {
+ "description": "Common properties for a page element.\n\nNote: When you initially create a\nPageElement, the API may modify\nthe values of both `size` and `transform`, but the\nvisual size will be unchanged.",
+ "type": "object",
+ "properties": {
+ "pageObjectId": {
+ "description": "The object ID of the page where the element is located.",
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "The size of the element."
+ },
+ "transform": {
+ "description": "The transform for the element.",
+ "$ref": "AffineTransform"
+ }
+ },
+ "id": "PageElementProperties"
+ },
+ "SheetsChartProperties": {
+ "description": "The properties of the SheetsChart.",
+ "type": "object",
+ "properties": {
+ "chartImageProperties": {
+ "description": "The properties of the embedded chart image.",
+ "$ref": "ImageProperties"
+ }
+ },
+ "id": "SheetsChartProperties"
+ },
+ "StretchedPictureFill": {
+ "description": "The stretched picture fill. The page or page element is filled entirely with\nthe specified picture. The picture is stretched to fit its container.",
+ "type": "object",
+ "properties": {
+ "contentUrl": {
+ "description": "Reading the content_url:\n\nAn URL to a picture with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the picture as the original requester. Access to the\npicture may be lost if the presentation's sharing settings change.\n\nWriting the content_url:\n\nThe picture is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Pictures must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.",
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "The original size of the picture fill. This field is read-only."
+ }
+ },
+ "id": "StretchedPictureFill"
+ },
+ "DeleteTableColumnRequest": {
+ "description": "Deletes a column from a table.",
+ "type": "object",
+ "properties": {
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted."
+ },
+ "tableObjectId": {
+ "description": "The table to delete columns from.",
+ "type": "string"
+ }
+ },
+ "id": "DeleteTableColumnRequest"
+ },
+ "UpdateTextStyleRequest": {
+ "id": "UpdateTextStyleRequest",
+ "description": "Update the styling of text in a Shape or\nTable.",
+ "type": "object",
+ "properties": {
+ "style": {
+ "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information.",
+ "$ref": "TextStyle"
},
"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."
+ "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."
},
"fields": {
- "type": "string",
"format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the text style to bold, set `fields` to `\"bold\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
},
"textRange": {
- "description": "The range of text containing the paragraph(s) to style.",
- "$ref": "Range"
+ "$ref": "Range",
+ "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style."
},
"objectId": {
"description": "The object ID of the shape or table with the text to be styled.",
"type": "string"
}
- },
- "id": "UpdateParagraphStyleRequest"
+ }
},
- "ColorScheme": {
+ "List": {
"properties": {
- "colors": {
- "description": "The ThemeColorType and corresponding concrete color pairs.",
- "items": {
- "$ref": "ThemeColorPair"
- },
- "type": "array"
+ "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",
+ "additionalProperties": {
+ "$ref": "NestingLevel"
+ }
+ },
+ "listId": {
+ "description": "The ID of the list.",
+ "type": "string"
}
},
- "id": "ColorScheme",
- "description": "The palette of predefined colors for a page.",
+ "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"
},
- "Shape": {
- "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification.",
+ "WeightedFontFamily": {
+ "id": "WeightedFontFamily",
+ "description": "Represents a font family and weight used to style a TextRun.",
"type": "object",
"properties": {
- "placeholder": {
+ "weight": {
+ "format": "int32",
+ "description": "The rendered weight of the text. This field can have any value that is a\nmultiple of `100` between `100` and `900`, inclusive. This range\ncorresponds to the numerical values described in the CSS 2.1\nSpecification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),\nwith non-numerical values disallowed. Weights greater than or equal to\n`700` are considered bold, and weights less than `700`are not bold. The\ndefault value is `400` (\"normal\").",
+ "type": "integer"
+ },
+ "fontFamily": {
+ "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.",
+ "type": "string"
+ }
+ }
+ },
+ "PageElement": {
+ "type": "object",
+ "properties": {
+ "size": {
+ "$ref": "Size",
+ "description": "The size of the page element."
+ },
+ "title": {
+ "description": "The title of the page element. Combined with description to display alt\ntext.",
+ "type": "string"
+ },
+ "sheetsChart": {
+ "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images.",
+ "$ref": "SheetsChart"
+ },
+ "video": {
+ "$ref": "Video",
+ "description": "A video page element."
+ },
+ "wordArt": {
+ "$ref": "WordArt",
+ "description": "A word art page element."
+ },
+ "table": {
+ "description": "A table page element.",
+ "$ref": "Table"
+ },
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "The transform of the 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"
+ },
+ "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": {
+ "description": "A collection of page elements joined as a single unit.",
+ "$ref": "Group"
+ },
+ "image": {
+ "description": "An image page element.",
+ "$ref": "Image"
+ }
+ },
+ "id": "PageElement",
+ "description": "A visual element rendered on a page."
+ },
+ "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"
+ }
+ },
+ "id": "CreateImageRequest"
+ },
+ "CreateParagraphBulletsRequest": {
+ "properties": {
+ "textRange": {
+ "description": "The range of text to apply the bullet presets to, based on TextElement indexes.",
+ "$ref": "Range"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table containing the text to add bullets to.",
+ "type": "string"
+ },
+ "bulletPreset": {
+ "enumDescriptions": [
+ "A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the\nfirst 3 list nesting levels.",
+ "A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
+ "A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph\nfor the first 3 list nesting levels.",
+ "A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet\nglyph for the first 3 list nesting levels.",
+ "A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph\nfor the first 3 list nesting levels.",
+ "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
+ "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by parenthesis.",
+ "A numbered list with `DIGIT` numeric glyphs separated by periods, where\neach nesting level uses the previous nesting level's glyph as a prefix.\nFor example: '1.', '1.1.', '2.', '2.2.'.",
+ "A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
+ "A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DIGIT` numeric glyphs\nfor the first 3 list nesting levels, followed by periods.",
+ "A numbered list with `ZERODIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods."
+ ],
+ "enum": [
+ "BULLET_DISC_CIRCLE_SQUARE",
+ "BULLET_DIAMONDX_ARROW3D_SQUARE",
+ "BULLET_CHECKBOX",
+ "BULLET_ARROW_DIAMOND_DISC",
+ "BULLET_STAR_CIRCLE_SQUARE",
+ "BULLET_ARROW3D_CIRCLE_SQUARE",
+ "BULLET_LEFTTRIANGLE_DIAMOND_DISC",
+ "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE",
+ "BULLET_DIAMOND_CIRCLE_SQUARE",
+ "NUMBERED_DIGIT_ALPHA_ROMAN",
+ "NUMBERED_DIGIT_ALPHA_ROMAN_PARENS",
+ "NUMBERED_DIGIT_NESTED",
+ "NUMBERED_UPPERALPHA_ALPHA_ROMAN",
+ "NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT",
+ "NUMBERED_ZERODIGIT_ALPHA_ROMAN"
+ ],
+ "description": "The kinds of bullet glyphs to be used. Defaults to the\n`BULLET_DISC_CIRCLE_SQUARE` preset.",
+ "type": "string"
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table."
+ }
+ },
+ "id": "CreateParagraphBulletsRequest",
+ "description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.",
+ "type": "object"
+ },
+ "TextStyle": {
+ "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor.",
+ "type": "object",
+ "properties": {
+ "fontFamily": {
+ "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.\n\nSome fonts can affect the weight of the text. If an update request\nspecifies values for both `font_family` and `bold`, the explicitly-set\n`bold` value is used.",
+ "type": "string"
+ },
+ "strikethrough": {
+ "description": "Whether or not the text is struck through.",
+ "type": "boolean"
+ },
+ "italic": {
+ "description": "Whether or not the text is italicized.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "description": "The size of the text's font. When read, the `font_size` will specified in\npoints.",
+ "$ref": "Dimension"
+ },
+ "baselineOffset": {
+ "enumDescriptions": [
+ "The text's baseline offset is inherited from the parent.",
+ "The text is not vertically offset.",
+ "The text is vertically offset upwards (superscript).",
+ "The text is vertically offset downwards (subscript)."
+ ],
+ "enum": [
+ "BASELINE_OFFSET_UNSPECIFIED",
+ "NONE",
+ "SUPERSCRIPT",
+ "SUBSCRIPT"
+ ],
+ "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field.",
+ "type": "string"
+ },
+ "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.",
+ "$ref": "WeightedFontFamily"
+ },
+ "smallCaps": {
+ "type": "boolean",
+ "description": "Whether or not the text is in small capital letters."
+ },
+ "backgroundColor": {
+ "$ref": "OptionalColor",
+ "description": "The background color of the text. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set."
+ },
+ "underline": {
+ "description": "Whether or not the text is underlined.",
+ "type": "boolean"
+ },
+ "link": {
+ "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"
+ },
+ "foregroundColor": {
+ "description": "The color of the text itself. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set.",
+ "$ref": "OptionalColor"
+ },
+ "bold": {
+ "description": "Whether or not the text is rendered as bold.",
+ "type": "boolean"
+ }
+ },
+ "id": "TextStyle"
+ },
+ "Size": {
+ "description": "A width and height.",
+ "type": "object",
+ "properties": {
+ "height": {
+ "description": "The height of the object.",
+ "$ref": "Dimension"
+ },
+ "width": {
+ "description": "The width of the object.",
+ "$ref": "Dimension"
+ }
+ },
+ "id": "Size"
+ },
+ "UpdateVideoPropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "videoProperties": {
+ "$ref": "VideoProperties",
+ "description": "The video properties to update."
+ },
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the video the updates are applied to.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateVideoPropertiesRequest",
+ "description": "Update the properties of a Video."
+ },
+ "Request": {
+ "properties": {
+ "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."
+ },
+ "createSlide": {
+ "$ref": "CreateSlideRequest",
+ "description": "Creates a new slide."
+ },
+ "insertTableRows": {
+ "description": "Inserts rows into a table.",
+ "$ref": "InsertTableRowsRequest"
+ },
+ "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": {
+ "description": "Deletes a row from a table.",
+ "$ref": "DeleteTableRowRequest"
+ },
+ "updateShapeProperties": {
+ "$ref": "UpdateShapePropertiesRequest",
+ "description": "Updates the properties of a Shape."
+ },
+ "insertText": {
+ "description": "Inserts text into a shape or table cell.",
+ "$ref": "InsertTextRequest"
+ },
+ "deleteText": {
+ "description": "Deletes text from a shape or a table cell.",
+ "$ref": "DeleteTextRequest"
+ },
+ "updatePageProperties": {
+ "$ref": "UpdatePagePropertiesRequest",
+ "description": "Updates the properties of a Page."
+ },
+ "createShape": {
+ "$ref": "CreateShapeRequest",
+ "description": "Creates a new shape."
+ },
+ "deleteParagraphBullets": {
+ "description": "Deletes bullets from paragraphs.",
+ "$ref": "DeleteParagraphBulletsRequest"
+ },
+ "insertTableColumns": {
+ "description": "Inserts columns into a table.",
+ "$ref": "InsertTableColumnsRequest"
+ },
+ "refreshSheetsChart": {
+ "$ref": "RefreshSheetsChartRequest",
+ "description": "Refreshes a Google Sheets chart."
+ },
+ "createTable": {
+ "$ref": "CreateTableRequest",
+ "description": "Creates a new table."
+ },
+ "updateTableCellProperties": {
+ "description": "Updates the properties of a TableCell.",
+ "$ref": "UpdateTableCellPropertiesRequest"
+ },
+ "deleteObject": {
+ "$ref": "DeleteObjectRequest",
+ "description": "Deletes a page or page element from the presentation."
+ },
+ "updateParagraphStyle": {
+ "$ref": "UpdateParagraphStyleRequest",
+ "description": "Updates the styling of paragraphs within a Shape or Table."
+ },
+ "deleteTableColumn": {
+ "$ref": "DeleteTableColumnRequest",
+ "description": "Deletes a column from a table."
+ },
+ "duplicateObject": {
+ "description": "Duplicates a slide or page element.",
+ "$ref": "DuplicateObjectRequest"
+ },
+ "createLine": {
+ "$ref": "CreateLineRequest",
+ "description": "Creates a line."
+ },
+ "updateVideoProperties": {
+ "$ref": "UpdateVideoPropertiesRequest",
+ "description": "Updates the properties of a Video."
+ },
+ "createImage": {
+ "$ref": "CreateImageRequest",
+ "description": "Creates an image."
+ },
+ "createParagraphBullets": {
+ "$ref": "CreateParagraphBulletsRequest",
+ "description": "Creates bullets for paragraphs."
+ },
+ "createVideo": {
+ "description": "Creates a video.",
+ "$ref": "CreateVideoRequest"
+ },
+ "createSheetsChart": {
+ "$ref": "CreateSheetsChartRequest",
+ "description": "Creates an embedded Google Sheets chart."
+ },
+ "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"
+ }
+ },
+ "id": "Request",
+ "description": "A single kind of update to apply to a presentation.",
+ "type": "object"
+ },
+ "UpdateImagePropertiesRequest": {
+ "description": "Update the properties of an Image.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "imageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The image properties to update."
+ },
+ "objectId": {
+ "description": "The object ID of the image the updates are applied to.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateImagePropertiesRequest"
+ },
+ "ParagraphStyle": {
+ "properties": {
+ "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": {
+ "enum": [
+ "SPACING_MODE_UNSPECIFIED",
+ "NEVER_COLLAPSE",
+ "COLLAPSE_LISTS"
+ ],
+ "description": "The spacing mode for the paragraph.",
+ "type": "string",
+ "enumDescriptions": [
+ "The spacing mode is inherited from the parent.",
+ "Paragraph spacing is always rendered.",
+ "Paragraph spacing is skipped between list elements."
+ ]
+ },
+ "indentEnd": {
+ "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.",
+ "$ref": "Dimension"
+ },
+ "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."
+ },
+ "indentFirstLine": {
+ "$ref": "Dimension",
+ "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent."
+ },
+ "lineSpacing": {
+ "type": "number",
+ "format": "float",
+ "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent."
+ },
+ "alignment": {
+ "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": {
+ "$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": {
+ "format": "int32",
+ "description": "The number of shapes replaced with charts.",
+ "type": "integer"
+ }
+ },
+ "id": "ReplaceAllShapesWithSheetsChartResponse",
+ "description": "The result of replacing shapes with a Google Sheets chart."
+ },
+ "TableCellProperties": {
+ "description": "The properties of the TableCell.",
+ "type": "object",
+ "properties": {
+ "tableCellBackgroundFill": {
+ "$ref": "TableCellBackgroundFill",
+ "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor."
+ }
+ },
+ "id": "TableCellProperties"
+ },
+ "RefreshSheetsChartRequest": {
+ "description": "Refreshes an embedded Google Sheets chart by replacing it with the latest\nversion of the chart from Google Sheets.\n\nNOTE: Refreshing charts requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the chart to refresh.",
+ "type": "string"
+ }
+ },
+ "id": "RefreshSheetsChartRequest"
+ },
+ "Outline": {
+ "id": "Outline",
+ "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
+ "type": "object",
+ "properties": {
+ "propertyState": {
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The outline property state.\n\nUpdating the the outline on a page element will implicitly update this\nfield to`RENDERED`, unless another value is specified in the same request.\nTo have no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.",
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ]
+ },
+ "outlineFill": {
+ "$ref": "OutlineFill",
+ "description": "The fill of the outline."
+ },
+ "weight": {
+ "description": "The thickness of the outline.",
+ "$ref": "Dimension"
+ },
+ "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"
+ }
+ }
+ },
+ "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"
+ },
+ "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."
+ },
+ "shadow": {
+ "$ref": "Shadow",
+ "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only."
+ },
+ "shapeBackgroundFill": {
+ "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor.",
+ "$ref": "ShapeBackgroundFill"
+ }
+ },
+ "id": "ShapeProperties"
+ },
+ "TableColumnProperties": {
+ "description": "Properties of each column in a table.",
+ "type": "object",
+ "properties": {
+ "columnWidth": {
+ "$ref": "Dimension",
+ "description": "Width of a column."
+ }
+ },
+ "id": "TableColumnProperties"
+ },
+ "TableRow": {
+ "description": "Properties and contents of each row in a table.",
+ "type": "object",
+ "properties": {
+ "tableCells": {
+ "description": "Properties and contents of each cell.\n\nCells that span multiple columns are represented only once with a\ncolumn_span greater\nthan 1. As a result, the length of this collection does not always match\nthe number of columns of the entire table.",
+ "items": {
+ "$ref": "TableCell"
+ },
+ "type": "array"
+ },
+ "rowHeight": {
+ "description": "Height of a row.",
+ "$ref": "Dimension"
+ }
+ },
+ "id": "TableRow"
+ },
+ "UpdateTableCellPropertiesRequest": {
+ "description": "Update the properties of a TableCell.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "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"
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ },
+ "tableCellProperties": {
+ "$ref": "TableCellProperties",
+ "description": "The table cell properties to update."
+ }
+ },
+ "id": "UpdateTableCellPropertiesRequest"
+ },
+ "CreateSlideRequest": {
+ "description": "Creates a new slide.",
+ "type": "object",
+ "properties": {
+ "placeholderIdMappings": {
+ "description": "An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)\nthat will be created on the new slide from that specified layout. Can only\nbe used when `slide_layout_reference` is specified.",
+ "items": {
+ "$ref": "LayoutPlaceholderIdMapping"
+ },
+ "type": "array"
+ },
+ "slideLayoutReference": {
+ "$ref": "LayoutReference",
+ "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`."
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ },
+ "insertionIndex": {
+ "format": "int32",
+ "description": "The optional zero-based index indicating where to insert the slides.\n\nIf you don't specify an index, the new slide is created at the end.",
+ "type": "integer"
+ }
+ },
+ "id": "CreateSlideRequest"
+ },
+ "BatchUpdatePresentationRequest": {
+ "properties": {
+ "requests": {
+ "description": "A list of updates to apply to the presentation.",
+ "items": {
+ "$ref": "Request"
+ },
+ "type": "array"
+ },
+ "writeControl": {
+ "$ref": "WriteControl",
+ "description": "Provides control over how write requests are executed."
+ }
+ },
+ "id": "BatchUpdatePresentationRequest",
+ "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.",
+ "items": {
+ "$ref": "TextElement"
+ },
+ "type": "array"
+ },
+ "lists": {
+ "description": "The bulleted lists contained in this text, keyed by list ID.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "List"
+ }
+ }
+ },
+ "id": "TextContent"
+ },
+ "CreateSheetsChartResponse": {
+ "description": "The result of creating an embedded Google Sheets chart.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the created chart."
+ }
+ },
+ "id": "CreateSheetsChartResponse"
+ },
+ "WriteControl": {
+ "description": "Provides control over how write requests are executed.",
+ "type": "object",
+ "properties": {
+ "requiredRevisionId": {
+ "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error.",
+ "type": "string"
+ }
+ },
+ "id": "WriteControl"
+ },
+ "DeleteParagraphBulletsRequest": {
+ "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": {
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to delete bullets from, based on TextElement indexes."
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table containing the text to delete bullets\nfrom.",
+ "type": "string"
+ },
+ "cellLocation": {
+ "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table.",
+ "$ref": "TableCellLocation"
+ }
+ },
+ "id": "DeleteParagraphBulletsRequest"
+ },
+ "ParagraphMarker": {
+ "description": "A TextElement kind that represents the beginning of a new paragraph.",
+ "type": "object",
+ "properties": {
+ "bullet": {
+ "$ref": "Bullet",
+ "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list."
+ },
+ "style": {
+ "description": "The paragraph's style",
+ "$ref": "ParagraphStyle"
+ }
+ },
+ "id": "ParagraphMarker"
+ },
+ "InsertTableColumnsRequest": {
+ "id": "InsertTableColumnsRequest",
+ "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "format": "int32",
+ "description": "The number of columns to be inserted. Maximum 20 per request.",
+ "type": "integer"
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which columns will be inserted.\n\nA new column will be inserted to the left (or right) of the column where\nthe reference cell is. If the reference cell is a merged cell, a new\ncolumn will be inserted to the left (or right) of the merged cell."
+ },
+ "insertRight": {
+ "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"
+ }
+ }
+ },
+ "Thumbnail": {
+ "type": "object",
+ "properties": {
+ "height": {
+ "format": "int32",
+ "description": "The positive height in pixels of the thumbnail image.",
+ "type": "integer"
+ },
+ "contentUrl": {
+ "description": "The content URL of the thumbnail image.\n\nThe URL to the image has a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.\nThe mime type of the thumbnail image is the same as specified in the\n`GetPageThumbnailRequest`.",
+ "type": "string"
+ },
+ "width": {
+ "format": "int32",
+ "description": "The positive width in pixels of the thumbnail image.",
+ "type": "integer"
+ }
+ },
+ "id": "Thumbnail",
+ "description": "The thumbnail of a page."
+ },
+ "LayoutPlaceholderIdMapping": {
+ "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout.",
+ "type": "object",
+ "properties": {
+ "layoutPlaceholder": {
"$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."
+ "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."
},
- "text": {
- "$ref": "TextContent",
- "description": "The text content of the shape."
+ "layoutPlaceholderObjectId": {
+ "description": "The object ID of the placeholder on a layout that will be applied\nto a slide.",
+ "type": "string"
},
+ "objectId": {
+ "description": "A user-supplied object ID for the placeholder identified above that to be\ncreated onto a slide.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ }
+ },
+ "id": "LayoutPlaceholderIdMapping"
+ },
+ "UpdateShapePropertiesRequest": {
+ "description": "Update the properties of a Shape.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the shape the updates are applied to."
+ },
+ "shapeProperties": {
+ "description": "The shape properties to update.",
+ "$ref": "ShapeProperties"
+ },
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `shapeProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the shape background solid fill color, set `fields`\nto `\"shapeBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateShapePropertiesRequest"
+ },
+ "WordArt": {
+ "description": "A PageElement kind representing\nword art.",
+ "type": "object",
+ "properties": {
+ "renderedText": {
+ "type": "string",
+ "description": "The text rendered as word art."
+ }
+ },
+ "id": "WordArt"
+ },
+ "Recolor": {
+ "description": "A recolor effect applied on an image.",
+ "type": "object",
+ "properties": {
+ "recolorStops": {
+ "description": "The recolor effect is represented by a gradient, which is a list of color\nstops.\n\nThe colors in the gradient will replace the corresponding colors at\nthe same position in the color palette and apply to the image. This\nproperty is read-only.",
+ "items": {
+ "$ref": "ColorStop"
+ },
+ "type": "array"
+ },
+ "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.",
+ "A recolor effect that lightens the image using the page's second\navailable color from its color scheme.",
+ "A recolor effect that lightens the image using the page's third available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's forth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's fifth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's sixth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's seventh\navailable color from its color scheme.e.",
+ "A recolor effect that lightens the image using the page's eighth\navailable color from its color scheme.",
+ "A recolor effect that lightens the image using the page's ninth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's tenth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's first available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's second available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's third available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's fourth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's fifth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's sixth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's seventh\navailable color from its color scheme.",
+ "A recolor effect that darkens the image using the page's eighth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's ninth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's tenth available\ncolor from its color scheme.",
+ "A recolor effect that recolors the image to grayscale.",
+ "A recolor effect that recolors the image to negative grayscale.",
+ "A recolor effect that recolors the image using the sepia color.",
+ "Custom recolor effect. Refer to `recolor_stops` for the concrete\ngradient."
+ ],
+ "enum": [
+ "NONE",
+ "LIGHT1",
+ "LIGHT2",
+ "LIGHT3",
+ "LIGHT4",
+ "LIGHT5",
+ "LIGHT6",
+ "LIGHT7",
+ "LIGHT8",
+ "LIGHT9",
+ "LIGHT10",
+ "DARK1",
+ "DARK2",
+ "DARK3",
+ "DARK4",
+ "DARK5",
+ "DARK6",
+ "DARK7",
+ "DARK8",
+ "DARK9",
+ "DARK10",
+ "GRAYSCALE",
+ "NEGATIVE",
+ "SEPIA",
+ "CUSTOM"
+ ]
+ }
+ },
+ "id": "Recolor"
+ },
+ "Link": {
+ "description": "A hypertext link.",
+ "type": "object",
+ "properties": {
+ "slideIndex": {
+ "format": "int32",
+ "description": "If set, indicates this is a link to the slide at this zero-based index\nin the presentation. There may not be a slide at this index.",
+ "type": "integer"
+ },
+ "relativeLink": {
+ "enumDescriptions": [
+ "An unspecified relative slide link.",
+ "A link to the next slide.",
+ "A link to the previous slide.",
+ "A link to the first slide in the presentation.",
+ "A link to the last slide in the presentation."
+ ],
+ "enum": [
+ "RELATIVE_SLIDE_LINK_UNSPECIFIED",
+ "NEXT_SLIDE",
+ "PREVIOUS_SLIDE",
+ "FIRST_SLIDE",
+ "LAST_SLIDE"
+ ],
+ "description": "If set, indicates this is a link to a slide in this presentation,\naddressed by its position.",
+ "type": "string"
+ },
+ "url": {
+ "description": "If set, indicates this is a link to the external web page at this URL.",
+ "type": "string"
+ },
+ "pageObjectId": {
+ "description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist.",
+ "type": "string"
+ }
+ },
+ "id": "Link"
+ },
+ "CreateShapeResponse": {
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created shape.",
+ "type": "string"
+ }
+ },
+ "id": "CreateShapeResponse",
+ "description": "The result of creating a shape.",
+ "type": "object"
+ },
+ "RgbColor": {
+ "description": "An RGB color.",
+ "type": "object",
+ "properties": {
+ "blue": {
+ "format": "float",
+ "description": "The blue component of the color, from 0.0 to 1.0.",
+ "type": "number"
+ },
+ "green": {
+ "format": "float",
+ "description": "The green component of the color, from 0.0 to 1.0.",
+ "type": "number"
+ },
+ "red": {
+ "type": "number",
+ "format": "float",
+ "description": "The red component of the color, from 0.0 to 1.0."
+ }
+ },
+ "id": "RgbColor"
+ },
+ "CreateLineRequest": {
+ "description": "Creates a line.",
+ "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 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.",
+ "Curved connectors, including curved connector 2 to 5."
+ ],
+ "enum": [
+ "STRAIGHT",
+ "BENT",
+ "CURVED"
+ ]
+ }
+ },
+ "id": "CreateLineRequest"
+ },
+ "CreateSlideResponse": {
+ "description": "The result of creating a slide.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created slide.",
+ "type": "string"
+ }
+ },
+ "id": "CreateSlideResponse"
+ },
+ "CreateShapeRequest": {
+ "description": "Creates a new shape.",
+ "type": "object",
+ "properties": {
"shapeType": {
"enumDescriptions": [
"The shape type that is not predefined.",
@@ -350,2227 +2542,966 @@
"CLOUD_CALLOUT",
"CUSTOM"
],
+ "description": "The shape type.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
+ "type": "string"
+ },
+ "elementProperties": {
+ "description": "The element properties for the shape.",
+ "$ref": "PageElementProperties"
+ }
+ },
+ "id": "CreateShapeRequest"
+ },
+ "Video": {
+ "id": "Video",
+ "description": "A PageElement kind representing a\nvideo.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
+ ],
+ "description": "The video source.",
+ "type": "string",
+ "enumDescriptions": [
+ "The video source is unspecified.",
+ "The video source is YouTube."
+ ]
+ },
+ "id": {
+ "description": "The video source's unique identifier for this video.",
+ "type": "string"
+ },
+ "url": {
+ "description": "An URL to a video. The URL is valid as long as the source video\nexists and sharing settings do not change.",
+ "type": "string"
+ },
+ "videoProperties": {
+ "description": "The properties of the video.",
+ "$ref": "VideoProperties"
+ }
+ }
+ },
+ "PageProperties": {
+ "description": "The properties of the Page.\n\nThe page will inherit properties from the parent page. Depending on the page\ntype the hierarchy is defined in either\nSlideProperties or\nLayoutProperties.",
+ "type": "object",
+ "properties": {
+ "pageBackgroundFill": {
+ "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor.",
+ "$ref": "PageBackgroundFill"
+ },
+ "colorScheme": {
+ "$ref": "ColorScheme",
+ "description": "The color scheme of the page. If unset, the color scheme is inherited from\na parent page. If the page has no parent, the color scheme uses a default\nSlides color scheme. This field is read-only."
+ }
+ },
+ "id": "PageProperties"
+ },
+ "NestingLevel": {
+ "properties": {
+ "bulletStyle": {
+ "description": "The style of a bullet at this level of nesting.",
+ "$ref": "TextStyle"
+ }
+ },
+ "id": "NestingLevel",
+ "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting.",
+ "type": "object"
+ },
+ "TableCell": {
+ "id": "TableCell",
+ "description": "Properties and contents of each table cell.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "$ref": "TextContent",
+ "description": "The text content of the cell."
+ },
+ "tableCellProperties": {
+ "description": "The properties of the table cell.",
+ "$ref": "TableCellProperties"
+ },
+ "rowSpan": {
+ "format": "int32",
+ "description": "Row span of the cell.",
+ "type": "integer"
+ },
+ "location": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell within the table."
+ },
+ "columnSpan": {
+ "format": "int32",
+ "description": "Column span of the cell.",
+ "type": "integer"
+ }
+ }
+ },
+ "UpdateLinePropertiesRequest": {
+ "description": "Updates the properties of a Line.",
+ "type": "object",
+ "properties": {
+ "lineProperties": {
+ "$ref": "LineProperties",
+ "description": "The line properties to update."
+ },
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `lineProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the line solid fill color, set `fields` to\n`\"lineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the line the update is applied to."
+ }
+ },
+ "id": "UpdateLinePropertiesRequest"
+ },
+ "TableCellBackgroundFill": {
+ "properties": {
+ "propertyState": {
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ],
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The background fill property state.\n\nUpdating the the fill on a table cell will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no fill on a table cell, set this field to `NOT_RENDERED`. In this\ncase, any other fill fields set in the same request will be ignored."
+ },
+ "solidFill": {
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
+ }
+ },
+ "id": "TableCellBackgroundFill",
+ "description": "The table cell background fill.",
+ "type": "object"
+ },
+ "UpdateSlidesPositionRequest": {
+ "type": "object",
+ "properties": {
+ "slideObjectIds": {
+ "description": "The IDs of the slides in the presentation that should be moved.\nThe slides in this list must be in existing presentation order, without\nduplicates.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertionIndex": {
+ "format": "int32",
+ "description": "The index where the slides should be inserted, based on the slide\narrangement before the move takes place. Must be between zero and the\nnumber of slides in the presentation, inclusive.",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateSlidesPositionRequest",
+ "description": "Updates the position of slides in the presentation."
+ },
+ "UpdatePagePropertiesRequest": {
+ "description": "Updates the properties of a Page.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "pageProperties": {
+ "description": "The page properties to update.",
+ "$ref": "PageProperties"
+ },
+ "objectId": {
+ "description": "The object ID of the page the update is applied to.",
+ "type": "string"
+ }
+ },
+ "id": "UpdatePagePropertiesRequest"
+ },
+ "Group": {
+ "id": "Group",
+ "description": "A PageElement kind representing a\njoined collection of PageElements.",
+ "type": "object",
+ "properties": {
+ "children": {
+ "description": "The collection of elements in the group. The minimum size of a group is 2.",
+ "items": {
+ "$ref": "PageElement"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "Placeholder": {
+ "type": "object",
+ "properties": {
+ "parentObjectId": {
+ "description": "The object ID of this shape's parent placeholder.\nIf unset, the parent placeholder shape does not exist, so the shape does\nnot inherit properties from any other shape.",
+ "type": "string"
+ },
+ "index": {
+ "format": "int32",
+ "description": "The index of the placeholder. If the same placeholder types are present in\nthe same page, they would have different index values.",
+ "type": "integer"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Default value, signifies it is not a placeholder.",
+ "Body text.",
+ "Chart or graph.",
+ "Clip art image.",
+ "Title centered.",
+ "Diagram.",
+ "Date and time.",
+ "Footer text.",
+ "Header text.",
+ "Multimedia.",
+ "Any content type.",
+ "Picture.",
+ "Number of a slide.",
+ "Subtitle.",
+ "Table.",
+ "Slide title.",
+ "Slide image."
+ ],
+ "enum": [
+ "NONE",
+ "BODY",
+ "CHART",
+ "CLIP_ART",
+ "CENTERED_TITLE",
+ "DIAGRAM",
+ "DATE_AND_TIME",
+ "FOOTER",
+ "HEADER",
+ "MEDIA",
+ "OBJECT",
+ "PICTURE",
+ "SLIDE_NUMBER",
+ "SUBTITLE",
+ "TABLE",
+ "TITLE",
+ "SLIDE_IMAGE"
+ ],
+ "description": "The type of the placeholder.",
+ "type": "string"
+ }
+ },
+ "id": "Placeholder",
+ "description": "The placeholder information that uniquely identifies a placeholder shape."
+ },
+ "DuplicateObjectRequest": {
+ "description": "Duplicates a slide or page element.\n\nWhen duplicating a slide, the duplicate slide will be created immediately\nfollowing the specified slide. When duplicating a page element, the duplicate\nwill be placed on the same page at the same position as the original.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The ID of the object to duplicate.",
+ "type": "string"
+ },
+ "objectIds": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The object being duplicated may contain other objects, for example when\nduplicating a slide or a group page element. This map defines how the IDs\nof duplicated objects are generated: the keys are the IDs of the original\nobjects and its values are the IDs that will be assigned to the\ncorresponding duplicate object. The ID of the source object's duplicate\nmay be specified in this map as well, using the same value of the\n`object_id` field as a key and the newly desired ID as the value.\n\nAll keys must correspond to existing IDs in the presentation. All values\nmust be unique in the presentation and must start with an alphanumeric\ncharacter or an underscore (matches regex `[a-zA-Z0-9_]`); remaining\ncharacters may include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or\ngreater than 50.\n\nIf any IDs of source objects are omitted from the map, a new random ID will\nbe assigned. If the map is empty or unset, all duplicate objects will\nreceive a new random ID.",
+ "type": "object"
+ }
+ },
+ "id": "DuplicateObjectRequest"
+ },
+ "ReplaceAllTextRequest": {
+ "description": "Replaces all instances of text matching a criteria with replace text.",
+ "type": "object",
+ "properties": {
+ "containsText": {
+ "description": "Finds text in a shape matching this substring.",
+ "$ref": "SubstringMatchCriteria"
+ },
+ "pageObjectIds": {
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes master,\nor if a page with that object ID doesn't exist in the presentation.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "replaceText": {
+ "description": "The text that will replace the matched text.",
+ "type": "string"
+ }
+ },
+ "id": "ReplaceAllTextRequest"
+ },
+ "Page": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID for this page. Object IDs used by\nPage and\nPageElement share the same namespace."
+ },
+ "revisionId": {
+ "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."
+ },
+ "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": [
+ "A slide page.",
+ "A master slide page.",
+ "A layout page.",
+ "A notes page.",
+ "A notes master page."
+ ]
+ },
+ "pageElements": {
+ "description": "The page elements rendered on the page.",
+ "items": {
+ "$ref": "PageElement"
+ },
+ "type": "array"
+ },
+ "slideProperties": {
+ "description": "Slide specific properties. Only set if page_type = SLIDE.",
+ "$ref": "SlideProperties"
+ },
+ "pageProperties": {
+ "description": "The properties of the page.",
+ "$ref": "PageProperties"
+ },
+ "masterProperties": {
+ "description": "Master specific properties. Only set if page_type = MASTER.",
+ "$ref": "MasterProperties"
+ }
+ },
+ "id": "Page",
+ "description": "A page in a presentation."
+ },
+ "ShapeBackgroundFill": {
+ "type": "object",
+ "properties": {
+ "solidFill": {
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
+ },
+ "propertyState": {
+ "description": "The background fill property state.\n\nUpdating the the fill on a shape will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a shape, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.",
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ],
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ]
+ }
+ },
+ "id": "ShapeBackgroundFill",
+ "description": "The shape background fill."
+ },
+ "CropProperties": {
+ "id": "CropProperties",
+ "description": "The crop properties of an object enclosed in a container. For example, an\nImage.\n\nThe crop properties is represented by the offsets of four edges which define\na crop rectangle. The offsets are measured in percentage from the\ncorresponding edges of the object's original bounding rectangle towards\ninside, relative to the object's original dimensions.\n\n- If the offset is in the interval (0, 1), the corresponding edge of crop\nrectangle is positioned inside of the object's original bounding rectangle.\n- If the offset is negative or greater than 1, the corresponding edge of crop\nrectangle is positioned outside of the object's original bounding rectangle.\n- If the left edge of the crop rectangle is on the right side of its right\nedge, the object will be flipped horizontally.\n- If the top edge of the crop rectangle is below its bottom edge, the object\nwill be flipped vertically.\n- If all offsets and rotation angle is 0, the object is not cropped.\n\nAfter cropping, the content in the crop rectangle will be stretched to fit\nits container.",
+ "type": "object",
+ "properties": {
+ "angle": {
+ "format": "float",
+ "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
+ "type": "number"
+ },
+ "topOffset": {
+ "format": "float",
+ "description": "The offset specifies the top edge of the crop rectangle that is located\nbelow the original bounding rectangle top edge, relative to the object's\noriginal height.",
+ "type": "number"
+ },
+ "leftOffset": {
+ "format": "float",
+ "description": "The offset specifies the left edge of the crop rectangle that is located to\nthe right of the original bounding rectangle left edge, relative to the\nobject's original width.",
+ "type": "number"
+ },
+ "rightOffset": {
+ "format": "float",
+ "description": "The offset specifies the right edge of the crop rectangle that is located\nto the left of the original bounding rectangle right edge, relative to the\nobject's original width.",
+ "type": "number"
+ },
+ "bottomOffset": {
+ "format": "float",
+ "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.",
+ "type": "number"
+ }
+ }
+ },
+ "ReplaceAllShapesWithSheetsChartRequest": {
+ "description": "Replaces all shapes that match the given criteria with the provided Google\nSheets chart. The chart will be scaled and centered to fit within the bounds\nof the original shape.\n\nNOTE: Replacing shapes with a chart requires at least one of the\nspreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object",
+ "properties": {
+ "linkingMode": {
+ "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"
+ ]
+ },
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
+ "type": "string"
+ },
+ "pageObjectIds": {
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "chartId": {
+ "format": "int32",
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
+ "type": "integer"
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "The criteria that the shapes must match in order to be replaced. The\nrequest will replace all of the shapes that contain the given text."
+ }
+ },
+ "id": "ReplaceAllShapesWithSheetsChartRequest"
+ },
+ "Range": {
+ "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
+ "type": "object",
+ "properties": {
+ "endIndex": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges."
+ },
+ "startIndex": {
+ "format": "int32",
+ "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.",
+ "type": "integer"
+ },
+ "type": {
+ "enum": [
+ "RANGE_TYPE_UNSPECIFIED",
+ "FIXED_RANGE",
+ "FROM_START_INDEX",
+ "ALL"
+ ],
+ "description": "The type of range.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified range type. This value must not be used.",
+ "A fixed range. Both the `start_index` and\n`end_index` must be specified.",
+ "Starts the range at `start_index` and continues until the\nend of the collection. The `end_index` must not be specified.",
+ "Sets the range to be the whole length of the collection. Both the\n`start_index` and the `end_index` must not be\nspecified."
+ ]
+ }
+ },
+ "id": "Range"
+ },
+ "ColorStop": {
+ "type": "object",
+ "properties": {
+ "position": {
+ "format": "float",
+ "description": "The relative position of the color stop in the gradient band measured\nin percentage. The value should be in the interval [0.0, 1.0].",
+ "type": "number"
+ },
+ "alpha": {
+ "format": "float",
+ "description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque.",
+ "type": "number"
+ },
+ "color": {
+ "$ref": "OpaqueColor",
+ "description": "The color of the gradient stop."
+ }
+ },
+ "id": "ColorStop",
+ "description": "A color and position in a gradient band."
+ },
+ "CreateVideoRequest": {
+ "description": "Creates a video.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "enumDescriptions": [
+ "The video source is unspecified.",
+ "The video source is YouTube."
+ ],
+ "enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
+ ],
+ "description": "The video source.",
+ "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"
+ },
+ "elementProperties": {
+ "$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.",
+ "type": "string"
+ }
+ },
+ "id": "CreateVideoRequest"
+ },
+ "DuplicateObjectResponse": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The ID of the new duplicate object.",
+ "type": "string"
+ }
+ },
+ "id": "DuplicateObjectResponse",
+ "description": "The response of duplicating an object."
+ },
+ "ReplaceAllShapesWithImageRequest": {
+ "description": "Replaces all shapes that match the given criteria with the provided image.",
+ "type": "object",
+ "properties": {
+ "imageUrl": {
+ "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.",
+ "type": "string"
+ },
+ "replaceMethod": {
+ "enum": [
+ "CENTER_INSIDE",
+ "CENTER_CROP"
+ ],
+ "description": "The replace method.",
+ "type": "string",
+ "enumDescriptions": [
+ "Scales and centers the image to fit within the bounds of the original\nshape and maintains the image's aspect ratio. The rendered size of the\nimage may be smaller than the size of the shape. This is the default\nmethod when one is not specified.",
+ "Scales and centers the image to fill the bounds of the original shape.\nThe image may be cropped in order to fill the shape. The rendered size of\nthe image will be the same as that of the original shape."
+ ]
+ },
+ "pageObjectIds": {
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "If set, this request will replace all of the shapes that contain the\ngiven text."
+ }
+ },
+ "id": "ReplaceAllShapesWithImageRequest"
+ },
+ "Shadow": {
+ "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 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."
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unspecified shadow type.",
+ "Outer shadow."
+ ],
+ "enum": [
+ "SHADOW_TYPE_UNSPECIFIED",
+ "OUTER"
+ ],
+ "description": "The type of the shadow.",
+ "type": "string"
+ },
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
+ },
+ "alignment": {
+ "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Top left.",
+ "Top center.",
+ "Top right.",
+ "Left center.",
+ "Center.",
+ "Right center.",
+ "Bottom left.",
+ "Bottom center.",
+ "Bottom right."
+ ],
+ "enum": [
+ "RECTANGLE_POSITION_UNSPECIFIED",
+ "TOP_LEFT",
+ "TOP_CENTER",
+ "TOP_RIGHT",
+ "LEFT_CENTER",
+ "CENTER",
+ "RIGHT_CENTER",
+ "BOTTOM_LEFT",
+ "BOTTOM_CENTER",
+ "BOTTOM_RIGHT"
+ ]
+ },
+ "alpha": {
+ "format": "float",
+ "description": "The alpha of the shadow's color, from 0.0 to 1.0.",
+ "type": "number"
+ },
+ "color": {
+ "$ref": "OpaqueColor",
+ "description": "The shadow color value."
+ },
+ "rotateWithShape": {
+ "description": "Whether the shadow should rotate with the shape.",
+ "type": "boolean"
+ }
+ },
+ "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"
+ },
+ "DeleteTableRowRequest": {
+ "description": "Deletes a row from a table.",
+ "type": "object",
+ "properties": {
+ "cellLocation": {
+ "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted.",
+ "$ref": "TableCellLocation"
+ },
+ "tableObjectId": {
+ "description": "The table to delete rows from.",
+ "type": "string"
+ }
+ },
+ "id": "DeleteTableRowRequest"
+ },
+ "Bullet": {
+ "description": "Describes the bullet of a paragraph.",
+ "type": "object",
+ "properties": {
+ "listId": {
+ "description": "The ID of the list this paragraph belongs to.",
+ "type": "string"
+ },
+ "glyph": {
+ "description": "The rendered bullet glyph for this paragraph.",
+ "type": "string"
+ },
+ "nestingLevel": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The nesting level of this paragraph in the list."
+ },
+ "bulletStyle": {
+ "$ref": "TextStyle",
+ "description": "The paragraph specific text style applied to this bullet."
+ }
+ },
+ "id": "Bullet"
+ },
+ "OutlineFill": {
+ "description": "The fill of the outline.",
+ "type": "object",
+ "properties": {
+ "solidFill": {
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
+ }
+ },
+ "id": "OutlineFill"
+ },
+ "TableCellLocation": {
+ "id": "TableCellLocation",
+ "description": "A location of a single table cell within a table.",
+ "type": "object",
+ "properties": {
+ "columnIndex": {
+ "format": "int32",
+ "description": "The 0-based column index.",
+ "type": "integer"
+ },
+ "rowIndex": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The 0-based row index."
+ }
+ }
+ },
+ "CreateLineResponse": {
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created line.",
+ "type": "string"
+ }
+ },
+ "id": "CreateLineResponse",
+ "description": "The result of creating a line.",
+ "type": "object"
+ },
+ "ReplaceAllTextResponse": {
+ "id": "ReplaceAllTextResponse",
+ "description": "The result of replacing text.",
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "format": "int32",
+ "description": "The number of occurrences changed by replacing all text.",
+ "type": "integer"
+ }
+ }
+ },
+ "UpdateParagraphStyleRequest": {
+ "properties": {
+ "style": {
+ "description": "The paragraph's style.",
+ "$ref": "ParagraphStyle"
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
+ },
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "textRange": {
+ "description": "The range of text containing the paragraph(s) to style.",
+ "$ref": "Range"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table with the text to be styled.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateParagraphStyleRequest",
+ "description": "Updates the styling for all of the paragraphs within a Shape or Table that\noverlap with the given text index range.",
+ "type": "object"
+ },
+ "ColorScheme": {
+ "description": "The palette of predefined colors for a page.",
+ "type": "object",
+ "properties": {
+ "colors": {
+ "description": "The ThemeColorType and corresponding concrete color pairs.",
+ "items": {
+ "$ref": "ThemeColorPair"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ColorScheme"
+ },
+ "Shape": {
+ "id": "Shape",
+ "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification.",
+ "type": "object",
+ "properties": {
+ "shapeProperties": {
+ "description": "The properties of the shape.",
+ "$ref": "ShapeProperties"
+ },
+ "placeholder": {
+ "$ref": "Placeholder",
+ "description": "Placeholders are shapes that are inherit from corresponding placeholders on\nlayouts and masters.\n\nIf set, the shape is a placeholder shape and any inherited properties\ncan be resolved by looking at the parent placeholder identified by the\nPlaceholder.parent_object_id field."
+ },
+ "text": {
+ "description": "The text content of the shape.",
+ "$ref": "TextContent"
+ },
+ "shapeType": {
+ "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"
- },
- "shapeProperties": {
- "$ref": "ShapeProperties",
- "description": "The properties of the shape."
- }
- },
- "id": "Shape"
- },
- "Image": {
- "description": "A PageElement kind representing an\nimage.",
- "type": "object",
- "properties": {
- "imageProperties": {
- "$ref": "ImageProperties",
- "description": "The properties of the image."
- },
- "contentUrl": {
- "description": "An URL to an image with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.",
- "type": "string"
- }
- },
- "id": "Image"
- },
- "AffineTransform": {
- "properties": {
- "shearY": {
- "format": "double",
- "description": "The Y coordinate shearing element.",
- "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": {
- "format": "double",
- "description": "The X coordinate scaling element.",
- "type": "number"
- },
- "shearX": {
- "format": "double",
- "description": "The X coordinate shearing element.",
- "type": "number"
- },
- "scaleY": {
- "format": "double",
- "description": "The Y coordinate scaling element.",
- "type": "number"
- },
- "translateY": {
- "format": "double",
- "description": "The Y coordinate translation element.",
- "type": "number"
- },
- "translateX": {
- "format": "double",
- "description": "The X coordinate translation element.",
- "type": "number"
- }
- },
- "id": "AffineTransform",
- "description": "AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ]\nto transform source coordinates (x,y) into destination coordinates (x', y')\naccording to:\n\n x' x = shear_y scale_y translate_y \n 1 [ 1 ]\n\nAfter transformation,\n\n x' = scale_x * x + shear_x * y + translate_x;\n y' = scale_y * y + shear_y * x + translate_y;\n\nThis message is therefore composed of these six matrix elements.",
- "type": "object"
- },
- "InsertTextRequest": {
- "description": "Inserts text into a shape or a table cell.",
- "type": "object",
- "properties": {
- "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"
- },
- "text": {
- "description": "The text to be inserted.\n\nInserting a newline character will implicitly create a new\nParagraphMarker at that index.\nThe paragraph style of the new paragraph will be copied from the paragraph\nat the current insertion index, including lists and bullets.\n\nText styles for inserted text will be determined automatically, generally\npreserving the styling of neighboring text. In most cases, the text will be\nadded to the TextRun that exists at the\ninsertion index.\n\nSome control characters (U+0000-U+0008, U+000C-U+001F) and characters\nfrom the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF)\nwill be stripped out of the inserted text.",
- "type": "string"
- },
- "objectId": {
- "description": "The object ID of the shape or table where the text will be inserted.",
- "type": "string"
- },
- "insertionIndex": {
- "format": "int32",
- "description": "The index where the text will be inserted, in Unicode code units, based\non TextElement indexes.\n\nThe index is zero-based and is computed from the start of the string.\nThe index may be adjusted to prevent insertions inside Unicode grapheme\nclusters. In these cases, the text will be inserted immediately after the\ngrapheme cluster.",
- "type": "integer"
- }
- },
- "id": "InsertTextRequest"
- },
- "AutoText": {
- "description": "A TextElement kind that represents auto text.",
- "type": "object",
- "properties": {
- "style": {
- "description": "The styling applied to this auto text.",
- "$ref": "TextStyle"
- },
- "content": {
- "description": "The rendered content of this auto text, if available.",
- "type": "string"
- },
- "type": {
- "type": "string",
- "enumDescriptions": [
- "An unspecified autotext type.",
- "Type for autotext that represents the current slide number."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "SLIDE_NUMBER"
- ],
- "description": "The type of this auto text."
- }
- },
- "id": "AutoText"
- },
- "CreateVideoResponse": {
- "description": "The result of creating a video.",
- "type": "object",
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the created video."
- }
- },
- "id": "CreateVideoResponse"
- },
- "UpdatePageElementTransformRequest": {
- "description": "Updates the transform of a page element.",
- "type": "object",
- "properties": {
- "transform": {
- "description": "The input transform matrix used to update the page element.",
- "$ref": "AffineTransform"
- },
- "objectId": {
- "description": "The object ID of the page element to update.",
- "type": "string"
- },
- "applyMode": {
- "enum": [
- "APPLY_MODE_UNSPECIFIED",
- "RELATIVE",
- "ABSOLUTE"
- ],
- "description": "The apply mode of the transform update.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified mode.",
- "Applies the new AffineTransform matrix to the existing one, and\nreplaces the existing one with the resulting concatenation.",
- "Replaces the existing AffineTransform matrix with the new one."
- ]
- }
- },
- "id": "UpdatePageElementTransformRequest"
- },
- "DeleteTextRequest": {
- "type": "object",
- "properties": {
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units."
- },
- "objectId": {
- "description": "The object ID of the shape or table from which the text will be deleted.",
- "type": "string"
- },
- "cellLocation": {
- "description": "The optional table cell location if the text is to be deleted from a table\ncell. If present, the object_id must refer to a table.",
- "$ref": "TableCellLocation"
- }
- },
- "id": "DeleteTextRequest",
- "description": "Deletes text from a shape or a table cell."
- },
- "DeleteObjectRequest": {
- "description": "Deletes an object, either pages or\npage elements, from the\npresentation.",
- "type": "object",
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the page or page element to delete.\n\nIf after a delete operation a group contains\nonly 1 or no page elements, the group is also deleted.\n\nIf a placeholder is deleted on a layout, any empty inheriting shapes are\nalso deleted."
- }
- },
- "id": "DeleteObjectRequest"
- },
- "TextElement": {
- "type": "object",
- "properties": {
- "paragraphMarker": {
- "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap.",
- "$ref": "ParagraphMarker"
- },
- "endIndex": {
- "format": "int32",
- "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.",
- "type": "integer"
- },
- "startIndex": {
- "format": "int32",
- "description": "The zero-based start index of this text element, in Unicode code units.",
- "type": "integer"
- },
- "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."
- }
- },
- "id": "TextElement",
- "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell."
- },
- "Dimension": {
- "properties": {
- "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 magnitude.",
- "type": "string"
- },
- "magnitude": {
- "format": "double",
- "description": "The magnitude.",
- "type": "number"
- }
- },
- "id": "Dimension",
- "description": "A magnitude in a single direction in the specified units.",
- "type": "object"
- },
- "LineFill": {
- "id": "LineFill",
- "description": "The fill of the line.",
- "type": "object",
- "properties": {
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- }
- }
- },
- "VideoProperties": {
- "properties": {
- "outline": {
- "$ref": "Outline",
- "description": "The outline of the video. The default outline matches the defaults for new\nvideos created in the Slides editor."
- }
- },
- "id": "VideoProperties",
- "description": "The properties of the Video.",
- "type": "object"
- },
- "InsertTableRowsRequest": {
- "description": "Inserts rows into a table.",
- "type": "object",
- "properties": {
- "number": {
- "format": "int32",
- "description": "The number of rows to be inserted. Maximum 20 per request.",
- "type": "integer"
- },
- "cellLocation": {
- "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell.",
- "$ref": "TableCellLocation"
- },
- "tableObjectId": {
- "description": "The table to insert rows into.",
- "type": "string"
- },
- "insertBelow": {
- "description": "Whether to insert new rows below the reference cell location.\n\n- `True`: insert below the cell.\n- `False`: insert above the cell.",
- "type": "boolean"
- }
- },
- "id": "InsertTableRowsRequest"
- },
- "LayoutProperties": {
- "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT.",
- "type": "object",
- "properties": {
- "masterObjectId": {
- "type": "string",
- "description": "The object ID of the master that this layout is based on."
- },
- "name": {
- "description": "The name of the layout.",
- "type": "string"
- },
- "displayName": {
- "description": "The human-readable name of the layout.",
- "type": "string"
- }
- },
- "id": "LayoutProperties"
- },
- "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.",
- "items": {
- "$ref": "Page"
- },
- "type": "array"
- },
- "revisionId": {
- "description": "The revision ID of the presentation. Can be used in update requests\nto assert that the presentation revision hasn't changed since the last\nread operation. Only populated if the user has edit access to the\npresentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
- "type": "string"
- },
- "notesMaster": {
- "$ref": "Page",
- "description": "The notes master in the presentation. It serves three purposes:\n\n- Placeholder shapes on a notes master contain the default text styles and\n shape properties of all placeholder shapes on notes pages. Specifically,\n a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a\n `BODY` placeholder shape contains the speaker notes.\n- The notes master page properties define the common page properties\n inherited by all notes pages.\n- Any other shapes on the notes master will appear on all notes pages.\n\nThe notes master is read-only."
- },
- "title": {
- "description": "The title of the presentation.",
- "type": "string"
- },
- "layouts": {
- "description": "The layouts in the presentation. A layout is a template that determines\nhow content is arranged and styled on the slides that inherit from that\nlayout.",
- "items": {
- "$ref": "Page"
- },
- "type": "array"
- },
- "masters": {
- "description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout.",
- "items": {
- "$ref": "Page"
- },
- "type": "array"
- },
- "locale": {
- "type": "string",
- "description": "The locale of the presentation, as an IETF BCP 47 language tag."
- },
- "pageSize": {
- "$ref": "Size",
- "description": "The size of pages in the presentation."
- }
- },
- "id": "Presentation"
- },
- "LineProperties": {
- "type": "object",
- "properties": {
- "dashStyle": {
- "description": "The dash style of the line.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ],
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ]
- },
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the line. If unset, there is no link."
- },
- "startArrow": {
- "enumDescriptions": [
- "An unspecified arrow style.",
- "No arrow.",
- "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
- "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
- "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
- "Filled square.",
- "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
- "Hollow arrow.",
- "Hollow circle.",
- "Hollow square.",
- "Hollow diamond."
- ],
- "enum": [
- "ARROW_STYLE_UNSPECIFIED",
- "NONE",
- "STEALTH_ARROW",
- "FILL_ARROW",
- "FILL_CIRCLE",
- "FILL_SQUARE",
- "FILL_DIAMOND",
- "OPEN_ARROW",
- "OPEN_CIRCLE",
- "OPEN_SQUARE",
- "OPEN_DIAMOND"
- ],
- "description": "The style of the arrow at the beginning of the line.",
- "type": "string"
- },
- "endArrow": {
- "enumDescriptions": [
- "An unspecified arrow style.",
- "No arrow.",
- "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
- "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
- "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
- "Filled square.",
- "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
- "Hollow arrow.",
- "Hollow circle.",
- "Hollow square.",
- "Hollow diamond."
- ],
- "enum": [
- "ARROW_STYLE_UNSPECIFIED",
- "NONE",
- "STEALTH_ARROW",
- "FILL_ARROW",
- "FILL_CIRCLE",
- "FILL_SQUARE",
- "FILL_DIAMOND",
- "OPEN_ARROW",
- "OPEN_CIRCLE",
- "OPEN_SQUARE",
- "OPEN_DIAMOND"
- ],
- "description": "The style of the arrow at the end of the line.",
- "type": "string"
- },
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the line."
- },
- "lineFill": {
- "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor.",
- "$ref": "LineFill"
- }
- },
- "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."
- },
- "OpaqueColor": {
- "properties": {
- "rgbColor": {
- "$ref": "RgbColor",
- "description": "An opaque RGB color."
- },
- "themeColor": {
- "description": "An opaque theme color.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified theme color. This value should not be used.",
- "Represents the first dark color.",
- "Represents the first light color.",
- "Represents the second dark color.",
- "Represents the second light color.",
- "Represents the first accent color.",
- "Represents the second accent color.",
- "Represents the third accent color.",
- "Represents the fourth accent color.",
- "Represents the fifth accent color.",
- "Represents the sixth accent color.",
- "Represents the color to use for hyperlinks.",
- "Represents the color to use for visited hyperlinks.",
- "Represents the first text color.",
- "Represents the first background color.",
- "Represents the second text color.",
- "Represents the second background color."
- ],
- "enum": [
- "THEME_COLOR_TYPE_UNSPECIFIED",
- "DARK1",
- "LIGHT1",
- "DARK2",
- "LIGHT2",
- "ACCENT1",
- "ACCENT2",
- "ACCENT3",
- "ACCENT4",
- "ACCENT5",
- "ACCENT6",
- "HYPERLINK",
- "FOLLOWED_HYPERLINK",
- "TEXT1",
- "BACKGROUND1",
- "TEXT2",
- "BACKGROUND2"
- ]
- }
- },
- "id": "OpaqueColor",
- "description": "A themeable solid color value.",
- "type": "object"
- },
- "ImageProperties": {
- "type": "object",
- "properties": {
- "brightness": {
- "format": "float",
- "description": "The brightness effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
- "type": "number"
- },
- "transparency": {
- "format": "float",
- "description": "The transparency effect of the image. The value should be in the interval\n[0.0, 1.0], where 0 means no effect and 1 means completely transparent.\nThis property is read-only.",
- "type": "number"
- },
- "shadow": {
- "$ref": "Shadow",
- "description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only."
- },
- "contrast": {
- "format": "float",
- "description": "The contrast effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
- "type": "number"
- },
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the image. If unset, there is no link."
- },
- "recolor": {
- "$ref": "Recolor",
- "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only."
- },
- "cropProperties": {
- "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."
- }
- },
- "id": "ImageProperties",
- "description": "The properties of the Image."
- },
- "ReplaceAllShapesWithImageResponse": {
- "description": "The result of replacing shapes with an image.",
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "format": "int32",
- "description": "The number of shapes replaced with images.",
- "type": "integer"
- }
- },
- "id": "ReplaceAllShapesWithImageResponse"
- },
- "Line": {
- "properties": {
- "lineType": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "STRAIGHT_CONNECTOR_1",
- "BENT_CONNECTOR_2",
- "BENT_CONNECTOR_3",
- "BENT_CONNECTOR_4",
- "BENT_CONNECTOR_5",
- "CURVED_CONNECTOR_2",
- "CURVED_CONNECTOR_3",
- "CURVED_CONNECTOR_4",
- "CURVED_CONNECTOR_5"
- ],
- "description": "The type of the line.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified line type.",
- "Straight connector 1 form. Corresponds to ECMA-376 ST_ShapeType\n'straightConnector1'.",
- "Bent connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector2'.",
- "Bent connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector3'.",
- "Bent connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector4'.",
- "Bent connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector5'.",
- "Curved connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector2'.",
- "Curved connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector3'.",
- "Curved connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector4'.",
- "Curved connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector5'."
- ]
- },
- "lineProperties": {
- "description": "The properties of the line.",
- "$ref": "LineProperties"
- }
- },
- "id": "Line",
- "description": "A PageElement kind representing a\nline, curved connector, or bent connector.",
- "type": "object"
- },
- "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"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the chart.\n\nWhen the aspect ratio of the provided size does not match the chart aspect\nratio, the chart is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
- },
- "linkingMode": {
- "enumDescriptions": [
- "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
- "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
- ],
- "enum": [
- "NOT_LINKED_IMAGE",
- "LINKED"
- ],
- "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked.",
- "type": "string"
- },
- "spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
- "type": "string"
- },
- "chartId": {
- "format": "int32",
- "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
- "type": "integer"
- }
- },
- "id": "CreateSheetsChartRequest"
- },
- "BatchUpdatePresentationResponse": {
- "description": "Response message from a batch update.",
- "type": "object",
- "properties": {
- "presentationId": {
- "type": "string",
- "description": "The presentation the updates were applied to."
- },
- "replies": {
- "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
- "items": {
- "$ref": "Response"
- },
- "type": "array"
- }
- },
- "id": "BatchUpdatePresentationResponse"
- },
- "CreateImageResponse": {
- "description": "The result of creating an image.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created image.",
- "type": "string"
- }
- },
- "id": "CreateImageResponse"
- },
- "SlideProperties": {
- "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."
- },
- "masterObjectId": {
- "description": "The object ID of the master that this slide is based on.",
- "type": "string"
- },
- "layoutObjectId": {
- "description": "The object ID of the layout that this slide is based on.",
- "type": "string"
- }
- },
- "id": "SlideProperties",
- "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE."
- },
- "MasterProperties": {
- "properties": {
- "displayName": {
- "description": "The human-readable name of the master.",
- "type": "string"
- }
- },
- "id": "MasterProperties",
- "description": "The properties of Page that are only\nrelevant for pages with page_type MASTER.",
- "type": "object"
- },
- "Response": {
- "description": "A single response from an update.",
- "type": "object",
- "properties": {
- "createVideo": {
- "$ref": "CreateVideoResponse",
- "description": "The result of creating a video."
- },
- "createSheetsChart": {
- "$ref": "CreateSheetsChartResponse",
- "description": "The result of creating a Google Sheets chart."
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartResponse",
- "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart."
- },
- "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": {
- "description": "The result of replacing text.",
- "$ref": "ReplaceAllTextResponse"
- },
- "createSlide": {
- "$ref": "CreateSlideResponse",
- "description": "The result of creating a slide."
- },
- "createShape": {
- "description": "The result of creating a shape.",
- "$ref": "CreateShapeResponse"
- },
- "duplicateObject": {
- "$ref": "DuplicateObjectResponse",
- "description": "The result of duplicating an object."
- },
- "createLine": {
- "description": "The result of creating a line.",
- "$ref": "CreateLineResponse"
- },
- "createImage": {
- "description": "The result of creating an image.",
- "$ref": "CreateImageResponse"
- }
- },
- "id": "Response"
- },
- "SubstringMatchCriteria": {
- "properties": {
- "text": {
- "description": "The text to search for in the shape or table.",
- "type": "string"
- },
- "matchCase": {
- "description": "Indicates whether the search should respect case:\n\n- `True`: the search is case sensitive.\n- `False`: the search is case insensitive.",
- "type": "boolean"
- }
- },
- "id": "SubstringMatchCriteria",
- "description": "A criteria that matches a specific string of text in a shape or table.",
- "type": "object"
- },
- "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": {
- "enumDescriptions": [
- "Unspecified layout.",
- "Blank layout, with no placeholders.",
- "Layout with a caption at the bottom.",
- "Layout with a title and a subtitle.",
- "Layout with a title and body.",
- "Layout with a title and two columns.",
- "Layout with only a title.",
- "Layout with a section title.",
- "Layout with a title and subtitle on one side and description on the other.",
- "Layout with one title and one body, arranged in a single column.",
- "Layout with a main point.",
- "Layout with a big number heading."
- ],
- "enum": [
- "PREDEFINED_LAYOUT_UNSPECIFIED",
- "BLANK",
- "CAPTION_ONLY",
- "TITLE",
- "TITLE_AND_BODY",
- "TITLE_AND_TWO_COLUMNS",
- "TITLE_ONLY",
- "SECTION_HEADER",
- "SECTION_TITLE_AND_DESCRIPTION",
- "ONE_COLUMN_TEXT",
- "MAIN_POINT",
- "BIG_NUMBER"
- ],
- "description": "Predefined layout.",
- "type": "string"
- }
- },
- "id": "LayoutReference"
- },
- "TextRun": {
- "type": "object",
- "properties": {
- "style": {
- "description": "The styling applied to this run.",
- "$ref": "TextStyle"
- },
- "content": {
- "description": "The text of this run.",
- "type": "string"
- }
- },
- "id": "TextRun",
- "description": "A TextElement kind that represents a run of text that all has the same\nstyling."
- },
- "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": {
- "columnSpan": {
- "type": "integer",
- "format": "int32",
- "description": "The column span of the table range."
- },
- "rowSpan": {
- "format": "int32",
- "description": "The row span of the table range.",
- "type": "integer"
- },
- "location": {
- "$ref": "TableCellLocation",
- "description": "The starting location of the table range."
- }
- },
- "id": "TableRange"
- },
- "CreateTableRequest": {
- "description": "Creates a new table.",
- "type": "object",
- "properties": {
- "rows": {
- "format": "int32",
- "description": "Number of rows in the table.",
- "type": "integer"
- },
- "columns": {
- "format": "int32",
- "description": "Number of columns in the table.",
- "type": "integer"
- },
- "objectId": {
- "type": "string",
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated."
- },
- "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."
- }
- },
- "id": "CreateTableRequest"
- },
- "CreateTableResponse": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created table.",
- "type": "string"
- }
- },
- "id": "CreateTableResponse",
- "description": "The result of creating a table."
- },
- "Table": {
- "properties": {
- "rows": {
- "format": "int32",
- "description": "Number of rows in the table.",
- "type": "integer"
- },
- "tableColumns": {
- "description": "Properties of each column.",
- "items": {
- "$ref": "TableColumnProperties"
- },
- "type": "array"
- },
- "columns": {
- "format": "int32",
- "description": "Number of columns in the table.",
- "type": "integer"
- },
- "tableRows": {
- "description": "Properties and contents of each row.\n\nCells that span multiple rows are contained in only one of these rows and\nhave a row_span greater\nthan 1.",
- "items": {
- "$ref": "TableRow"
- },
- "type": "array"
- }
- },
- "id": "Table",
- "description": "A PageElement kind representing a\ntable.",
- "type": "object"
- },
- "PageBackgroundFill": {
- "description": "The page background fill.",
- "type": "object",
- "properties": {
- "stretchedPictureFill": {
- "$ref": "StretchedPictureFill",
- "description": "Stretched picture fill."
- },
- "solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
- },
- "propertyState": {
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The background fill property state.\n\nUpdating the the fill on a page will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a page, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.",
- "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": "PageBackgroundFill"
- },
- "SheetsChart": {
- "id": "SheetsChart",
- "description": "A PageElement kind representing\na linked chart embedded from Google Sheets.",
- "type": "object",
- "properties": {
- "chartId": {
- "format": "int32",
- "description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.",
- "type": "integer"
- },
- "sheetsChartProperties": {
- "$ref": "SheetsChartProperties",
- "description": "The properties of the Sheets chart."
- },
- "contentUrl": {
- "description": "The URL of an image of the embedded chart, with a default lifetime of 30\nminutes. This URL is tagged with the account of the requester. Anyone with\nthe URL effectively accesses the image as the original requester. Access to\nthe image may be lost if the presentation's sharing settings change.",
- "type": "string"
- },
- "spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the source chart.",
- "type": "string"
- }
- }
- },
- "SolidFill": {
- "description": "A solid color fill. The page or page element is filled entirely with the\nspecified color value.\n\nIf any field is unset, its value may be inherited from a parent placeholder\nif it exists.",
- "type": "object",
- "properties": {
- "color": {
- "$ref": "OpaqueColor",
- "description": "The color value of the solid fill."
- },
- "alpha": {
- "format": "float",
- "description": "The fraction of this `color` that should be applied to the pixel.\nThat is, the final pixel color is defined by the equation:\n\n pixel color = alpha * (color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color.",
- "type": "number"
- }
- },
- "id": "SolidFill"
- },
- "ThemeColorPair": {
- "description": "A pair mapping a theme color type to the concrete color it represents.",
- "type": "object",
- "properties": {
- "color": {
- "$ref": "RgbColor",
- "description": "The concrete color corresponding to the theme color type above."
- },
- "type": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified theme color. This value should not be used.",
- "Represents the first dark color.",
- "Represents the first light color.",
- "Represents the second dark color.",
- "Represents the second light color.",
- "Represents the first accent color.",
- "Represents the second accent color.",
- "Represents the third accent color.",
- "Represents the fourth accent color.",
- "Represents the fifth accent color.",
- "Represents the sixth accent color.",
- "Represents the color to use for hyperlinks.",
- "Represents the color to use for visited hyperlinks.",
- "Represents the first text color.",
- "Represents the first background color.",
- "Represents the second text color.",
- "Represents the second background color."
- ],
- "enum": [
- "THEME_COLOR_TYPE_UNSPECIFIED",
- "DARK1",
- "LIGHT1",
- "DARK2",
- "LIGHT2",
- "ACCENT1",
- "ACCENT2",
- "ACCENT3",
- "ACCENT4",
- "ACCENT5",
- "ACCENT6",
- "HYPERLINK",
- "FOLLOWED_HYPERLINK",
- "TEXT1",
- "BACKGROUND1",
- "TEXT2",
- "BACKGROUND2"
- ],
- "description": "The type of the theme color."
- }
- },
- "id": "ThemeColorPair"
- },
- "OptionalColor": {
- "type": "object",
- "properties": {
- "opaqueColor": {
- "$ref": "OpaqueColor",
- "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
- }
- },
- "id": "OptionalColor",
- "description": "A color that can either be fully opaque or fully transparent."
- },
- "PageElementProperties": {
- "description": "Common properties for a page element.\n\nNote: When you initially create a\nPageElement, the API may modify\nthe values of both `size` and `transform`, but the\nvisual size will be unchanged.",
- "type": "object",
- "properties": {
- "pageObjectId": {
- "description": "The object ID of the page where the element is located.",
- "type": "string"
- },
- "size": {
- "description": "The size of the element.",
- "$ref": "Size"
- },
- "transform": {
- "$ref": "AffineTransform",
- "description": "The transform for the element."
- }
- },
- "id": "PageElementProperties"
- },
- "SheetsChartProperties": {
- "type": "object",
- "properties": {
- "chartImageProperties": {
- "description": "The properties of the embedded chart image.",
- "$ref": "ImageProperties"
- }
- },
- "id": "SheetsChartProperties",
- "description": "The properties of the SheetsChart."
- },
- "StretchedPictureFill": {
- "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"
- }
- },
- "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"
- },
- "UpdateTextStyleRequest": {
- "description": "Update the styling of text in a Shape or\nTable.",
- "type": "object",
- "properties": {
- "style": {
- "$ref": "TextStyle",
- "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information."
- },
- "cellLocation": {
- "description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not.",
- "$ref": "TableCellLocation"
- },
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the text style to bold, set `fields` to `\"bold\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "type": "string"
- },
- "textRange": {
- "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style.",
- "$ref": "Range"
- },
- "objectId": {
- "description": "The object ID of the shape or table with the text to be styled.",
- "type": "string"
- }
- },
- "id": "UpdateTextStyleRequest"
- },
- "DeleteTableColumnRequest": {
- "description": "Deletes a column from a table.",
- "type": "object",
- "properties": {
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted."
- },
- "tableObjectId": {
- "type": "string",
- "description": "The table to delete columns from."
- }
- },
- "id": "DeleteTableColumnRequest"
- },
- "List": {
- "type": "object",
- "properties": {
- "nestingLevel": {
- "additionalProperties": {
- "$ref": "NestingLevel"
- },
- "description": "A map of nesting levels to the properties of bullets at the associated\nlevel. A list has at most nine levels of nesting, so the possible values\nfor the keys of this map are 0 through 8, inclusive.",
- "type": "object"
- },
- "listId": {
- "description": "The ID of the list.",
- "type": "string"
- }
- },
- "id": "List",
- "description": "A List describes the look and feel of bullets belonging to paragraphs\nassociated with a list. A paragraph that is part of a list has an implicit\nreference to that list's ID."
- },
- "WeightedFontFamily": {
- "description": "Represents a font family and weight used to style a TextRun.",
- "type": "object",
- "properties": {
- "weight": {
- "format": "int32",
- "description": "The rendered weight of the text. This field can have any value that is a\nmultiple of `100` between `100` and `900`, inclusive. This range\ncorresponds to the numerical values described in the CSS 2.1\nSpecification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),\nwith non-numerical values disallowed. Weights greater than or equal to\n`700` are considered bold, and weights less than `700`are not bold. The\ndefault value is `400` (\"normal\").",
- "type": "integer"
- },
- "fontFamily": {
- "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.",
- "type": "string"
- }
- },
- "id": "WeightedFontFamily"
- },
- "PageElement": {
- "description": "A visual element rendered on a page.",
- "type": "object",
- "properties": {
- "size": {
- "description": "The size of the page element.",
- "$ref": "Size"
- },
- "sheetsChart": {
- "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images.",
- "$ref": "SheetsChart"
- },
- "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": {
- "description": "A word art page element.",
- "$ref": "WordArt"
- },
- "table": {
- "description": "A table page element.",
- "$ref": "Table"
- },
- "transform": {
- "$ref": "AffineTransform",
- "description": "The transform of the 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"
- },
- "shape": {
- "description": "A generic shape.",
- "$ref": "Shape"
- },
- "line": {
- "$ref": "Line",
- "description": "A line page element."
- },
- "description": {
- "type": "string",
- "description": "The description of the page element. Combined with title to display alt\ntext."
- },
- "elementGroup": {
- "description": "A collection of page elements joined as a single unit.",
- "$ref": "Group"
- },
- "image": {
- "$ref": "Image",
- "description": "An image page element."
- }
- },
- "id": "PageElement"
- },
- "CreateImageRequest": {
- "description": "Creates an image.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the image.\n\nWhen the aspect ratio of the provided size does not match the image aspect\nratio, the image is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
- },
- "url": {
- "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.",
- "type": "string"
- }
- },
- "id": "CreateImageRequest"
- },
- "CreateParagraphBulletsRequest": {
- "id": "CreateParagraphBulletsRequest",
- "description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.",
- "type": "object",
- "properties": {
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to apply the bullet presets to, based on TextElement indexes."
- },
- "objectId": {
- "description": "The object ID of the shape or table containing the text to add bullets to.",
- "type": "string"
- },
- "bulletPreset": {
- "description": "The kinds of bullet glyphs to be used. Defaults to the\n`BULLET_DISC_CIRCLE_SQUARE` preset.",
- "type": "string",
- "enumDescriptions": [
- "A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the\nfirst 3 list nesting levels.",
- "A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
- "A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph\nfor the first 3 list nesting levels.",
- "A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet\nglyph for the first 3 list nesting levels.",
- "A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph\nfor the first 3 list nesting levels.",
- "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
- "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by parenthesis.",
- "A numbered list with `DIGIT` numeric glyphs separated by periods, where\neach nesting level uses the previous nesting level's glyph as a prefix.\nFor example: '1.', '1.1.', '2.', '2.2.'.",
- "A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
- "A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DIGIT` numeric glyphs\nfor the first 3 list nesting levels, followed by periods.",
- "A numbered list with `ZERODIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods."
- ],
- "enum": [
- "BULLET_DISC_CIRCLE_SQUARE",
- "BULLET_DIAMONDX_ARROW3D_SQUARE",
- "BULLET_CHECKBOX",
- "BULLET_ARROW_DIAMOND_DISC",
- "BULLET_STAR_CIRCLE_SQUARE",
- "BULLET_ARROW3D_CIRCLE_SQUARE",
- "BULLET_LEFTTRIANGLE_DIAMOND_DISC",
- "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE",
- "BULLET_DIAMOND_CIRCLE_SQUARE",
- "NUMBERED_DIGIT_ALPHA_ROMAN",
- "NUMBERED_DIGIT_ALPHA_ROMAN_PARENS",
- "NUMBERED_DIGIT_NESTED",
- "NUMBERED_UPPERALPHA_ALPHA_ROMAN",
- "NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT",
- "NUMBERED_ZERODIGIT_ALPHA_ROMAN"
- ]
- },
- "cellLocation": {
- "$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."
- }
- }
- },
- "TextStyle": {
- "id": "TextStyle",
- "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor.",
- "type": "object",
- "properties": {
- "bold": {
- "type": "boolean",
- "description": "Whether or not the text is rendered as bold."
- },
- "foregroundColor": {
- "$ref": "OptionalColor",
- "description": "The color of the text itself. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set."
- },
- "fontFamily": {
- "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": {
- "description": "The size of the text's font. When read, the `font_size` will specified in\npoints.",
- "$ref": "Dimension"
- },
- "baselineOffset": {
- "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)."
- ],
- "enum": [
- "BASELINE_OFFSET_UNSPECIFIED",
- "NONE",
- "SUPERSCRIPT",
- "SUBSCRIPT"
- ]
- },
- "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.",
- "$ref": "WeightedFontFamily"
- },
- "smallCaps": {
- "type": "boolean",
- "description": "Whether or not the text is in small capital letters."
- },
- "backgroundColor": {
- "$ref": "OptionalColor",
- "description": "The background color of the text. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set."
- },
- "underline": {
- "description": "Whether or not the text is underlined.",
- "type": "boolean"
- },
- "link": {
- "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"
- }
- }
- },
- "Size": {
- "description": "A width and height.",
- "type": "object",
- "properties": {
- "width": {
- "$ref": "Dimension",
- "description": "The width of the object."
- },
- "height": {
- "description": "The height of the object.",
- "$ref": "Dimension"
- }
- },
- "id": "Size"
- },
- "UpdateVideoPropertiesRequest": {
- "description": "Update the properties of a Video.",
- "type": "object",
- "properties": {
- "videoProperties": {
- "$ref": "VideoProperties",
- "description": "The video properties to update."
- },
- "fields": {
- "type": "string",
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
- },
- "objectId": {
- "description": "The object ID of the video the updates are applied to.",
- "type": "string"
- }
- },
- "id": "UpdateVideoPropertiesRequest"
- },
- "Request": {
- "description": "A single kind of update to apply to a presentation.",
- "type": "object",
- "properties": {
- "createImage": {
- "$ref": "CreateImageRequest",
- "description": "Creates an image."
- },
- "createParagraphBullets": {
- "$ref": "CreateParagraphBulletsRequest",
- "description": "Creates bullets for paragraphs."
- },
- "createVideo": {
- "$ref": "CreateVideoRequest",
- "description": "Creates a video."
- },
- "createSheetsChart": {
- "description": "Creates an embedded Google Sheets chart.",
- "$ref": "CreateSheetsChartRequest"
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartRequest",
- "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
- },
- "updatePageElementTransform": {
- "$ref": "UpdatePageElementTransformRequest",
- "description": "Updates the transform of a page element."
- },
- "updateTextStyle": {
- "description": "Updates the styling of text within a Shape or Table.",
- "$ref": "UpdateTextStyleRequest"
- },
- "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": {
- "$ref": "InsertTableRowsRequest",
- "description": "Inserts rows into a table."
- },
- "createSlide": {
- "description": "Creates a new slide.",
- "$ref": "CreateSlideRequest"
- },
- "updateLineProperties": {
- "description": "Updates the properties of a Line.",
- "$ref": "UpdateLinePropertiesRequest"
- },
- "updateSlidesPosition": {
- "$ref": "UpdateSlidesPositionRequest",
- "description": "Updates the position of a set of slides in the presentation."
- },
- "deleteTableRow": {
- "description": "Deletes a row from a table.",
- "$ref": "DeleteTableRowRequest"
- },
- "updateShapeProperties": {
- "description": "Updates the properties of a Shape.",
- "$ref": "UpdateShapePropertiesRequest"
- },
- "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": {
- "$ref": "DeleteParagraphBulletsRequest",
- "description": "Deletes bullets from paragraphs."
- },
- "insertTableColumns": {
- "description": "Inserts columns into a table.",
- "$ref": "InsertTableColumnsRequest"
- },
- "refreshSheetsChart": {
- "description": "Refreshes a Google Sheets chart.",
- "$ref": "RefreshSheetsChartRequest"
- },
- "createTable": {
- "$ref": "CreateTableRequest",
- "description": "Creates a new table."
- },
- "updateTableCellProperties": {
- "$ref": "UpdateTableCellPropertiesRequest",
- "description": "Updates the properties of a TableCell."
- },
- "deleteObject": {
- "$ref": "DeleteObjectRequest",
- "description": "Deletes a page or page element from the presentation."
- },
- "updateParagraphStyle": {
- "$ref": "UpdateParagraphStyleRequest",
- "description": "Updates the styling of paragraphs within a Shape or Table."
- },
- "duplicateObject": {
- "$ref": "DuplicateObjectRequest",
- "description": "Duplicates a slide or page element."
- },
- "deleteTableColumn": {
- "$ref": "DeleteTableColumnRequest",
- "description": "Deletes a column from a table."
- },
- "createLine": {
- "$ref": "CreateLineRequest",
- "description": "Creates a line."
- },
- "updateVideoProperties": {
- "description": "Updates the properties of a Video.",
- "$ref": "UpdateVideoPropertiesRequest"
- }
- },
- "id": "Request"
- },
- "UpdateImagePropertiesRequest": {
- "id": "UpdateImagePropertiesRequest",
- "description": "Update the properties of an Image.",
- "type": "object",
- "properties": {
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "type": "string"
- },
- "imageProperties": {
- "$ref": "ImageProperties",
- "description": "The image properties to update."
- },
- "objectId": {
- "description": "The object ID of the image the updates are applied to.",
- "type": "string"
- }
- }
- },
- "ParagraphStyle": {
- "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",
- "properties": {
- "spaceBelow": {
- "$ref": "Dimension",
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
- },
- "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."
- ]
- },
- "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."
- },
- "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": {
- "format": "float",
- "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent.",
- "type": "number"
- },
- "indentFirstLine": {
- "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent.",
- "$ref": "Dimension"
- }
- }
- },
- "ReplaceAllShapesWithSheetsChartResponse": {
- "description": "The result of replacing shapes with a Google Sheets chart.",
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "format": "int32",
- "description": "The number of shapes replaced with charts.",
- "type": "integer"
- }
- },
- "id": "ReplaceAllShapesWithSheetsChartResponse"
- },
- "TableCellProperties": {
- "description": "The properties of the TableCell.",
- "type": "object",
- "properties": {
- "tableCellBackgroundFill": {
- "$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": {
- "properties": {
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the outline."
- },
- "dashStyle": {
- "description": "The dash style of the outline.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ],
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ]
- },
- "propertyState": {
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The outline property state.\n\nUpdating the the outline on a page element will implicitly update this\nfield to`RENDERED`, unless another value is specified in the same request.\nTo have no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.",
- "type": "string"
- },
- "outlineFill": {
- "description": "The fill of the outline.",
- "$ref": "OutlineFill"
- }
- },
- "id": "Outline",
- "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
- "type": "object"
- },
- "TableColumnProperties": {
- "id": "TableColumnProperties",
- "description": "Properties of each column in a table.",
- "type": "object",
- "properties": {
- "columnWidth": {
- "$ref": "Dimension",
- "description": "Width of a column."
- }
- }
- },
- "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": {
- "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders.",
- "$ref": "Link"
- },
- "outline": {
- "$ref": "Outline",
- "description": "The outline of the shape. If unset, the outline is inherited from a\nparent placeholder if it exists. If the shape has no parent, then the\ndefault outline depends on the shape type, matching the defaults for\nnew shapes created in the Slides editor."
- },
- "shadow": {
- "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"
- },
- "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."
- }
- },
- "id": "ShapeProperties"
- },
- "NotesProperties": {
- "id": "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"
- }
- }
- },
- "TableRow": {
- "description": "Properties and contents of each row in a table.",
- "type": "object",
- "properties": {
- "tableCells": {
- "description": "Properties and contents of each cell.\n\nCells that span multiple columns are represented only once with a\ncolumn_span greater\nthan 1. As a result, the length of this collection does not always match\nthe number of columns of the entire table.",
- "items": {
- "$ref": "TableCell"
- },
- "type": "array"
- },
- "rowHeight": {
- "$ref": "Dimension",
- "description": "Height of a row."
- }
- },
- "id": "TableRow"
- },
- "UpdateTableCellPropertiesRequest": {
- "description": "Update the properties of a TableCell.",
- "type": "object",
- "properties": {
- "tableRange": {
- "$ref": "TableRange",
- "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the table."
- },
- "tableCellProperties": {
- "$ref": "TableCellProperties",
- "description": "The table cell properties to update."
- },
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "type": "string"
- }
- },
- "id": "UpdateTableCellPropertiesRequest"
- },
- "CreateSlideRequest": {
- "description": "Creates a new slide.",
- "type": "object",
- "properties": {
- "slideLayoutReference": {
- "$ref": "LayoutReference",
- "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`."
- },
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "insertionIndex": {
- "type": "integer",
- "format": "int32",
- "description": "The optional zero-based index indicating where to insert the slides.\n\nIf you don't specify an index, the new slide is created at the end."
- },
- "placeholderIdMappings": {
- "description": "An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)\nthat will be created on the new slide from that specified layout. Can only\nbe used when `slide_layout_reference` is specified.",
- "items": {
- "$ref": "LayoutPlaceholderIdMapping"
- },
- "type": "array"
- }
- },
- "id": "CreateSlideRequest"
- },
- "BatchUpdatePresentationRequest": {
- "id": "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.",
- "items": {
- "$ref": "Request"
- },
- "type": "array"
- }
- }
- },
- "TextContent": {
- "description": "The general text content. The text must reside in a compatible shape (e.g.\ntext box or rectangle) or a table cell in a page.",
- "type": "object",
- "properties": {
- "lists": {
- "additionalProperties": {
- "$ref": "List"
- },
- "description": "The bulleted lists contained in this text, keyed by list ID.",
- "type": "object"
- },
- "textElements": {
- "description": "The text contents broken down into its component parts, including styling\ninformation. This property is read-only.",
- "items": {
- "$ref": "TextElement"
- },
- "type": "array"
- }
- },
- "id": "TextContent"
- },
- "CreateSheetsChartResponse": {
- "id": "CreateSheetsChartResponse",
- "description": "The result of creating an embedded Google Sheets chart.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created chart.",
- "type": "string"
- }
- }
- },
- "WriteControl": {
- "type": "object",
- "properties": {
- "requiredRevisionId": {
- "type": "string",
- "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error."
- }
- },
- "id": "WriteControl",
- "description": "Provides control over how write requests are executed."
- },
- "DeleteParagraphBulletsRequest": {
- "properties": {
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to delete bullets from, based on TextElement indexes."
- },
- "objectId": {
- "description": "The object ID of the shape or table containing the text to delete bullets\nfrom.",
- "type": "string"
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table."
- }
- },
- "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"
- },
- "ParagraphMarker": {
- "type": "object",
- "properties": {
- "style": {
- "$ref": "ParagraphStyle",
- "description": "The paragraph's style"
- },
- "bullet": {
- "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list.",
- "$ref": "Bullet"
- }
- },
- "id": "ParagraphMarker",
- "description": "A TextElement kind that represents the beginning of a new paragraph."
- },
- "Thumbnail": {
- "description": "The thumbnail of a page.",
- "type": "object",
- "properties": {
- "width": {
- "format": "int32",
- "description": "The positive width in pixels of the thumbnail image.",
- "type": "integer"
- },
- "height": {
- "format": "int32",
- "description": "The positive height in pixels of the thumbnail image.",
- "type": "integer"
- },
- "contentUrl": {
- "description": "The content URL of the thumbnail image.\n\nThe URL to the image has a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.\nThe mime type of the thumbnail image is the same as specified in the\n`GetPageThumbnailRequest`.",
- "type": "string"
- }
- },
- "id": "Thumbnail"
- },
- "InsertTableColumnsRequest": {
- "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
- "type": "object",
- "properties": {
- "number": {
- "format": "int32",
- "description": "The number of columns to be inserted. Maximum 20 per request.",
- "type": "integer"
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which columns will be inserted.\n\nA new column will be inserted to the left (or right) of the column where\nthe reference cell is. If the reference cell is a merged cell, a new\ncolumn will be inserted to the left (or right) of the merged cell."
- },
- "insertRight": {
- "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"
- },
- "LayoutPlaceholderIdMapping": {
- "type": "object",
- "properties": {
- "objectId": {
- "type": "string",
- "description": "A user-supplied object ID for the placeholder identified above that to be\ncreated onto a slide.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated."
- },
- "layoutPlaceholder": {
- "$ref": "Placeholder",
- "description": "The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a\npredefined `TITLE_AND_BODY` layout may usually have a TITLE placeholder\nwith index 0 and a BODY placeholder with index 0."
- },
- "layoutPlaceholderObjectId": {
- "description": "The object ID of the placeholder on a layout that will be applied\nto a slide.",
- "type": "string"
- }
- },
- "id": "LayoutPlaceholderIdMapping",
- "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout."
- },
- "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": {
- "description": "The shape properties to update.",
- "$ref": "ShapeProperties"
- },
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `shapeProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the shape background solid fill color, set `fields`\nto `\"shapeBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "type": "string"
- }
- },
- "id": "UpdateShapePropertiesRequest"
- },
- "WordArt": {
- "id": "WordArt",
- "description": "A PageElement kind representing\nword art.",
- "type": "object",
- "properties": {
- "renderedText": {
- "description": "The text rendered as word art.",
- "type": "string"
- }
- }
- },
- "Recolor": {
- "description": "A recolor effect applied on an image.",
- "type": "object",
- "properties": {
- "name": {
- "enumDescriptions": [
- "No recolor effect. The default value.",
- "A recolor effect that lightens the image using the page's first available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's second\navailable color from its color scheme.",
- "A recolor effect that lightens the image using the page's third available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's forth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's fifth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's sixth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's seventh\navailable color from its color scheme.e.",
- "A recolor effect that lightens the image using the page's eighth\navailable color from its color scheme.",
- "A recolor effect that lightens the image using the page's ninth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's tenth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's first available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's second available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's third available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's fourth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's fifth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's sixth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's seventh\navailable color from its color scheme.",
- "A recolor effect that darkens the image using the page's eighth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's ninth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's tenth available\ncolor from its color scheme.",
- "A recolor effect that recolors the image to grayscale.",
- "A recolor effect that recolors the image to negative grayscale.",
- "A recolor effect that recolors the image using the sepia color.",
- "Custom recolor effect. Refer to `recolor_stops` for the concrete\ngradient."
- ],
- "enum": [
- "NONE",
- "LIGHT1",
- "LIGHT2",
- "LIGHT3",
- "LIGHT4",
- "LIGHT5",
- "LIGHT6",
- "LIGHT7",
- "LIGHT8",
- "LIGHT9",
- "LIGHT10",
- "DARK1",
- "DARK2",
- "DARK3",
- "DARK4",
- "DARK5",
- "DARK6",
- "DARK7",
- "DARK8",
- "DARK9",
- "DARK10",
- "GRAYSCALE",
- "NEGATIVE",
- "SEPIA",
- "CUSTOM"
- ],
- "description": "The name of the recolor effect.\n\nThe name is determined from the `recolor_stops` by matching the gradient\nagainst the colors in the page's current color scheme. This property is\nread-only.",
- "type": "string"
- },
- "recolorStops": {
- "description": "The recolor effect is represented by a gradient, which is a list of color\nstops.\n\nThe colors in the gradient will replace the corresponding colors at\nthe same position in the color palette and apply to the image. This\nproperty is read-only.",
- "items": {
- "$ref": "ColorStop"
- },
- "type": "array"
- }
- },
- "id": "Recolor"
- },
- "Link": {
- "description": "A hypertext link.",
- "type": "object",
- "properties": {
- "pageObjectId": {
- "description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist.",
- "type": "string"
- },
- "slideIndex": {
- "format": "int32",
- "description": "If set, indicates this is a link to the slide at this zero-based index\nin the presentation. There may not be a slide at this index.",
- "type": "integer"
- },
- "relativeLink": {
- "enumDescriptions": [
- "An unspecified relative slide link.",
- "A link to the next slide.",
- "A link to the previous slide.",
- "A link to the first slide in the presentation.",
- "A link to the last slide in the presentation."
- ],
- "enum": [
- "RELATIVE_SLIDE_LINK_UNSPECIFIED",
- "NEXT_SLIDE",
- "PREVIOUS_SLIDE",
- "FIRST_SLIDE",
- "LAST_SLIDE"
- ],
- "description": "If set, indicates this is a link to a slide in this presentation,\naddressed by its position.",
- "type": "string"
- },
- "url": {
- "description": "If set, indicates this is a link to the external web page at this URL.",
- "type": "string"
- }
- },
- "id": "Link"
- },
- "CreateShapeResponse": {
- "description": "The result of creating a shape.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created shape.",
- "type": "string"
- }
- },
- "id": "CreateShapeResponse"
- },
- "RgbColor": {
- "properties": {
- "red": {
- "type": "number",
- "format": "float",
- "description": "The red component of the color, from 0.0 to 1.0."
- },
- "blue": {
- "format": "float",
- "description": "The blue component of the color, from 0.0 to 1.0.",
- "type": "number"
- },
- "green": {
- "type": "number",
- "format": "float",
- "description": "The green component of the color, from 0.0 to 1.0."
- }
- },
- "id": "RgbColor",
- "description": "An RGB color.",
- "type": "object"
- },
- "CreateLineRequest": {
- "description": "Creates a line.",
- "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 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.",
- "Curved connectors, including curved connector 2 to 5."
- ],
- "enum": [
- "STRAIGHT",
- "BENT",
- "CURVED"
- ]
- }
- },
- "id": "CreateLineRequest"
- },
- "CreateSlideResponse": {
- "description": "The result of creating a slide.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created slide.",
- "type": "string"
- }
- },
- "id": "CreateSlideResponse"
- },
- "CreateShapeRequest": {
- "type": "object",
- "properties": {
- "shapeType": {
- "description": "The shape type.",
"type": "string",
"enumDescriptions": [
"The shape type that is not predefined.",
@@ -2716,1209 +3647,278 @@
"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"
]
- },
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
- "type": "string"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the shape."
- }
- },
- "id": "CreateShapeRequest",
- "description": "Creates a new shape."
- },
- "Video": {
- "description": "A PageElement kind representing a\nvideo.",
- "type": "object",
- "properties": {
- "id": {
- "description": "The video source's unique identifier for this video.",
- "type": "string"
- },
- "url": {
- "description": "An URL to a video. The URL is valid as long as the source video\nexists and sharing settings do not change.",
- "type": "string"
- },
- "videoProperties": {
- "$ref": "VideoProperties",
- "description": "The properties of the video."
- },
- "source": {
- "type": "string",
- "enumDescriptions": [
- "The video source is unspecified.",
- "The video source is YouTube."
- ],
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ],
- "description": "The video source."
- }
- },
- "id": "Video"
- },
- "PageProperties": {
- "description": "The properties of the Page.\n\nThe page will inherit properties from the parent page. Depending on the page\ntype the hierarchy is defined in either\nSlideProperties or\nLayoutProperties.",
- "type": "object",
- "properties": {
- "colorScheme": {
- "$ref": "ColorScheme",
- "description": "The color scheme of the page. If unset, the color scheme is inherited from\na parent page. If the page has no parent, the color scheme uses a default\nSlides color scheme. This field is read-only."
- },
- "pageBackgroundFill": {
- "$ref": "PageBackgroundFill",
- "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor."
- }
- },
- "id": "PageProperties"
- },
- "TableCell": {
- "description": "Properties and contents of each table cell.",
- "type": "object",
- "properties": {
- "rowSpan": {
- "format": "int32",
- "description": "Row span of the cell.",
- "type": "integer"
- },
- "location": {
- "$ref": "TableCellLocation",
- "description": "The location of the cell within the table."
- },
- "columnSpan": {
- "format": "int32",
- "description": "Column span of the cell.",
- "type": "integer"
- },
- "text": {
- "$ref": "TextContent",
- "description": "The text content of the cell."
- },
- "tableCellProperties": {
- "$ref": "TableCellProperties",
- "description": "The properties of the table cell."
- }
- },
- "id": "TableCell"
- },
- "NestingLevel": {
- "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting.",
- "type": "object",
- "properties": {
- "bulletStyle": {
- "description": "The style of a bullet at this level of nesting.",
- "$ref": "TextStyle"
- }
- },
- "id": "NestingLevel"
- },
- "UpdateLinePropertiesRequest": {
- "properties": {
- "lineProperties": {
- "$ref": "LineProperties",
- "description": "The line properties to update."
- },
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `lineProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the line solid fill color, set `fields` to\n`\"lineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "type": "string"
- },
- "objectId": {
- "description": "The object ID of the line the update is applied to.",
- "type": "string"
- }
- },
- "id": "UpdateLinePropertiesRequest",
- "description": "Updates the properties of a Line.",
- "type": "object"
- },
- "TableCellBackgroundFill": {
- "id": "TableCellBackgroundFill",
- "description": "The table cell background fill.",
- "type": "object",
- "properties": {
- "propertyState": {
- "description": "The background fill property state.\n\nUpdating the the fill on a table cell will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no fill on a table cell, set this field to `NOT_RENDERED`. In this\ncase, any other fill fields set in the same request will be ignored.",
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ]
- },
- "solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
}
}
},
- "UpdateSlidesPositionRequest": {
+ "Image": {
+ "description": "A PageElement kind representing an\nimage.",
"type": "object",
"properties": {
- "slideObjectIds": {
- "description": "The IDs of the slides in the presentation that should be moved.\nThe slides in this list must be in existing presentation order, without\nduplicates.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "imageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The properties of the image."
+ },
+ "contentUrl": {
+ "description": "An URL to an image with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.",
+ "type": "string"
+ }
+ },
+ "id": "Image"
+ },
+ "AffineTransform": {
+ "type": "object",
+ "properties": {
+ "shearX": {
+ "format": "double",
+ "description": "The X coordinate shearing element.",
+ "type": "number"
+ },
+ "scaleY": {
+ "format": "double",
+ "description": "The Y coordinate scaling element.",
+ "type": "number"
+ },
+ "translateY": {
+ "format": "double",
+ "description": "The Y coordinate translation element.",
+ "type": "number"
+ },
+ "translateX": {
+ "format": "double",
+ "description": "The X coordinate translation element.",
+ "type": "number"
+ },
+ "shearY": {
+ "format": "double",
+ "description": "The Y coordinate shearing element.",
+ "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": {
+ "format": "double",
+ "description": "The X coordinate scaling element.",
+ "type": "number"
+ }
+ },
+ "id": "AffineTransform",
+ "description": "AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ]\nto transform source coordinates (x,y) into destination coordinates (x', y')\naccording to:\n\n x' x = shear_y scale_y translate_y \n 1 [ 1 ]\n\nAfter transformation,\n\n x' = scale_x * x + shear_x * y + translate_x;\n y' = scale_y * y + shear_y * x + translate_y;\n\nThis message is therefore composed of these six matrix elements."
+ },
+ "InsertTextRequest": {
+ "description": "Inserts text into a shape or a table cell.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The text to be inserted.\n\nInserting a newline character will implicitly create a new\nParagraphMarker at that index.\nThe paragraph style of the new paragraph will be copied from the paragraph\nat the current insertion index, including lists and bullets.\n\nText styles for inserted text will be determined automatically, generally\npreserving the styling of neighboring text. In most cases, the text will be\nadded to the TextRun that exists at the\ninsertion index.\n\nSome control characters (U+0000-U+0008, U+000C-U+001F) and characters\nfrom the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF)\nwill be stripped out of the inserted text.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table where the text will be inserted.",
+ "type": "string"
},
"insertionIndex": {
"format": "int32",
- "description": "The index where the 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.",
+ "description": "The index where the text will be inserted, in Unicode code units, based\non TextElement indexes.\n\nThe index is zero-based and is computed from the start of the string.\nThe index may be adjusted to prevent insertions inside Unicode grapheme\nclusters. In these cases, the text will be inserted immediately after the\ngrapheme cluster.",
"type": "integer"
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table."
}
},
- "id": "UpdateSlidesPositionRequest",
- "description": "Updates the position of slides in the presentation."
+ "id": "InsertTextRequest"
},
- "UpdatePagePropertiesRequest": {
- "description": "Updates the properties of a Page.",
+ "AutoText": {
+ "description": "A TextElement kind that represents auto text.",
"type": "object",
"properties": {
- "pageProperties": {
- "description": "The page properties to update.",
- "$ref": "PageProperties"
- },
- "objectId": {
- "description": "The object ID of the page the update is applied to.",
+ "content": {
+ "description": "The rendered content of this auto text, if available.",
"type": "string"
},
- "fields": {
- "type": "string",
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
- }
- },
- "id": "UpdatePagePropertiesRequest"
- },
- "Group": {
- "type": "object",
- "properties": {
- "children": {
- "description": "The collection of elements in the group. The minimum size of a group is 2.",
- "items": {
- "$ref": "PageElement"
- },
- "type": "array"
- }
- },
- "id": "Group",
- "description": "A PageElement kind representing a\njoined collection of PageElements."
- },
- "Placeholder": {
- "description": "The placeholder information that uniquely identifies a placeholder shape.",
- "type": "object",
- "properties": {
- "index": {
- "format": "int32",
- "description": "The index of the placeholder. If the same placeholder types are present in\nthe same page, they would have different index values.",
- "type": "integer"
- },
"type": {
- "description": "The type of the placeholder.",
+ "description": "The type of this auto text.",
"type": "string",
"enumDescriptions": [
- "Default value, signifies it is not a placeholder.",
- "Body text.",
- "Chart or graph.",
- "Clip art image.",
- "Title centered.",
- "Diagram.",
- "Date and time.",
- "Footer text.",
- "Header text.",
- "Multimedia.",
- "Any content type.",
- "Picture.",
- "Number of a slide.",
- "Subtitle.",
- "Table.",
- "Slide title.",
- "Slide image."
+ "An unspecified autotext type.",
+ "Type for autotext that represents the current slide number."
],
"enum": [
- "NONE",
- "BODY",
- "CHART",
- "CLIP_ART",
- "CENTERED_TITLE",
- "DIAGRAM",
- "DATE_AND_TIME",
- "FOOTER",
- "HEADER",
- "MEDIA",
- "OBJECT",
- "PICTURE",
- "SLIDE_NUMBER",
- "SUBTITLE",
- "TABLE",
- "TITLE",
- "SLIDE_IMAGE"
+ "TYPE_UNSPECIFIED",
+ "SLIDE_NUMBER"
]
},
- "parentObjectId": {
- "description": "The object ID of this shape's parent placeholder.\nIf unset, the parent placeholder shape does not exist, so the shape does\nnot inherit properties from any other shape.",
- "type": "string"
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The styling applied to this auto text."
}
},
- "id": "Placeholder"
+ "id": "AutoText"
},
- "DuplicateObjectRequest": {
- "description": "Duplicates a slide or page element.\n\nWhen duplicating a slide, the duplicate slide will be created immediately\nfollowing the specified slide. When duplicating a page element, the duplicate\nwill be placed on the same page at the same position as the original.",
+ "CreateVideoResponse": {
+ "description": "The result of creating a video.",
"type": "object",
"properties": {
- "objectIds": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The object being duplicated may contain other objects, for example when\nduplicating a slide or a group page element. This map defines how the IDs\nof duplicated objects are generated: the keys are the IDs of the original\nobjects and its values are the IDs that will be assigned to the\ncorresponding duplicate object. The ID of the source object's duplicate\nmay be specified in this map as well, using the same value of the\n`object_id` field as a key and the newly desired ID as the value.\n\nAll keys must correspond to existing IDs in the presentation. All values\nmust be unique in the presentation and must start with an alphanumeric\ncharacter or an underscore (matches regex `[a-zA-Z0-9_]`); remaining\ncharacters may include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or\ngreater than 50.\n\nIf any IDs of source objects are omitted from the map, a new random ID will\nbe assigned. If the map is empty or unset, all duplicate objects will\nreceive a new random ID.",
- "type": "object"
- },
"objectId": {
- "description": "The ID of the object to duplicate.",
+ "description": "The object ID of the created video.",
"type": "string"
}
},
- "id": "DuplicateObjectRequest"
+ "id": "CreateVideoResponse"
},
- "ReplaceAllTextRequest": {
- "properties": {
- "containsText": {
- "description": "Finds text in a shape matching this substring.",
- "$ref": "SubstringMatchCriteria"
- },
- "pageObjectIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes master,\nor if a page with that object ID doesn't exist in the presentation."
- },
- "replaceText": {
- "description": "The text that will replace the matched text.",
- "type": "string"
- }
- },
- "id": "ReplaceAllTextRequest",
- "description": "Replaces all instances of text matching a criteria with replace text.",
- "type": "object"
- },
- "Page": {
- "description": "A page in a presentation.",
+ "UpdatePageElementTransformRequest": {
+ "id": "UpdatePageElementTransformRequest",
+ "description": "Updates the transform of a page element.",
"type": "object",
"properties": {
- "revisionId": {
- "description": "The revision ID of the presentation containing this page. Can be used in\nupdate requests to assert that the presentation revision hasn't changed\nsince the last read operation. Only populated if the user has edit access\nto the presentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
- "type": "string"
- },
- "layoutProperties": {
- "$ref": "LayoutProperties",
- "description": "Layout specific properties. Only set if page_type = LAYOUT."
- },
- "notesProperties": {
- "description": "Notes specific properties. Only set if page_type = NOTES.",
- "$ref": "NotesProperties"
- },
- "pageType": {
- "enumDescriptions": [
- "A slide page.",
- "A master slide page.",
- "A layout page.",
- "A notes page.",
- "A notes master page."
- ],
+ "applyMode": {
"enum": [
- "SLIDE",
- "MASTER",
- "LAYOUT",
- "NOTES",
- "NOTES_MASTER"
+ "APPLY_MODE_UNSPECIFIED",
+ "RELATIVE",
+ "ABSOLUTE"
],
- "description": "The type of the page.",
- "type": "string"
- },
- "pageElements": {
- "description": "The page elements rendered on the page.",
- "items": {
- "$ref": "PageElement"
- },
- "type": "array"
- },
- "pageProperties": {
- "$ref": "PageProperties",
- "description": "The properties of the page."
- },
- "slideProperties": {
- "$ref": "SlideProperties",
- "description": "Slide specific properties. Only set if page_type = SLIDE."
- },
- "masterProperties": {
- "description": "Master specific properties. Only set if page_type = MASTER.",
- "$ref": "MasterProperties"
- },
- "objectId": {
- "description": "The object ID for this page. Object IDs used by\nPage and\nPageElement share the same namespace.",
- "type": "string"
- }
- },
- "id": "Page"
- },
- "ShapeBackgroundFill": {
- "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.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The background fill property state.\n\nUpdating the the fill on a shape will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a shape, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.",
- "type": "string"
- }
- },
- "id": "ShapeBackgroundFill",
- "description": "The shape background fill."
- },
- "CropProperties": {
- "id": "CropProperties",
- "description": "The crop properties of an object enclosed in a container. For example, an\nImage.\n\nThe crop properties is represented by the offsets of four edges which define\na crop rectangle. The offsets are measured in percentage from the\ncorresponding edges of the object's original bounding rectangle towards\ninside, relative to the object's original dimensions.\n\n- If the offset is in the interval (0, 1), the corresponding edge of crop\nrectangle is positioned inside of the object's original bounding rectangle.\n- If the offset is negative or greater than 1, the corresponding edge of crop\nrectangle is positioned outside of the object's original bounding rectangle.\n- If the left edge of the crop rectangle is on the right side of its right\nedge, the object will be flipped horizontally.\n- If the top edge of the crop rectangle is below its bottom edge, the object\nwill be flipped vertically.\n- If all offsets and rotation angle is 0, the object is not cropped.\n\nAfter cropping, the content in the crop rectangle will be stretched to fit\nits container.",
- "type": "object",
- "properties": {
- "bottomOffset": {
- "format": "float",
- "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.",
- "type": "number"
- },
- "angle": {
- "format": "float",
- "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
- "type": "number"
- },
- "topOffset": {
- "format": "float",
- "description": "The offset specifies the top edge of the crop rectangle that is located\nbelow the original bounding rectangle top edge, relative to the object's\noriginal height.",
- "type": "number"
- },
- "leftOffset": {
- "format": "float",
- "description": "The offset specifies the left edge of the crop rectangle that is located to\nthe right of the original bounding rectangle left edge, relative to the\nobject's original width.",
- "type": "number"
- },
- "rightOffset": {
- "format": "float",
- "description": "The offset specifies the right edge of the crop rectangle that is located\nto the left of the original bounding rectangle right edge, relative to the\nobject's original width.",
- "type": "number"
- }
- }
- },
- "ReplaceAllShapesWithSheetsChartRequest": {
- "description": "Replaces all shapes that match the given criteria with the provided Google\nSheets chart. The chart will be scaled and centered to fit within the bounds\nof the original shape.\n\nNOTE: Replacing shapes with a chart requires at least one of the\nspreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.",
- "type": "object",
- "properties": {
- "linkingMode": {
- "enumDescriptions": [
- "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
- "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
- ],
- "enum": [
- "NOT_LINKED_IMAGE",
- "LINKED"
- ],
- "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked.",
- "type": "string"
- },
- "spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
- "type": "string"
- },
- "pageObjectIds": {
- "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "chartId": {
- "format": "int32",
- "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
- "type": "integer"
- },
- "containsText": {
- "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.",
- "$ref": "SubstringMatchCriteria"
- }
- },
- "id": "ReplaceAllShapesWithSheetsChartRequest"
- },
- "ColorStop": {
- "description": "A color and position in a gradient band.",
- "type": "object",
- "properties": {
- "position": {
- "format": "float",
- "description": "The relative position of the color stop in the gradient band measured\nin percentage. The value should be in the interval [0.0, 1.0].",
- "type": "number"
- },
- "alpha": {
- "format": "float",
- "description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque.",
- "type": "number"
- },
- "color": {
- "description": "The color of the gradient stop.",
- "$ref": "OpaqueColor"
- }
- },
- "id": "ColorStop"
- },
- "Range": {
- "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
- "type": "object",
- "properties": {
- "type": {
- "enum": [
- "RANGE_TYPE_UNSPECIFIED",
- "FIXED_RANGE",
- "FROM_START_INDEX",
- "ALL"
- ],
- "description": "The type of range.",
+ "description": "The apply mode of the transform update.",
"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."
- ]
- },
- "endIndex": {
- "type": "integer",
- "format": "int32",
- "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges."
- },
- "startIndex": {
- "format": "int32",
- "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.",
- "type": "integer"
- }
- },
- "id": "Range"
- },
- "CreateVideoRequest": {
- "description": "Creates a video.",
- "type": "object",
- "properties": {
- "source": {
- "enumDescriptions": [
- "The video source is unspecified.",
- "The video source is YouTube."
- ],
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ],
- "description": "The video source.",
- "type": "string"
- },
- "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 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.",
- "type": "string"
- }
- },
- "id": "CreateVideoRequest"
- },
- "DuplicateObjectResponse": {
- "description": "The response of duplicating an object.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The ID of the new duplicate object.",
- "type": "string"
- }
- },
- "id": "DuplicateObjectResponse"
- },
- "ReplaceAllShapesWithImageRequest": {
- "description": "Replaces all shapes that match the given criteria with the provided image.",
- "type": "object",
- "properties": {
- "imageUrl": {
- "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.",
- "type": "string"
- },
- "replaceMethod": {
- "enum": [
- "CENTER_INSIDE",
- "CENTER_CROP"
- ],
- "description": "The replace method.",
- "type": "string",
- "enumDescriptions": [
- "Scales and centers the image to fit within the bounds of the original\nshape and maintains the image's aspect ratio. The rendered size of the\nimage may be smaller than the size of the shape. This is the default\nmethod when one is not specified.",
- "Scales and centers the image to fill the bounds of the original shape.\nThe image may be cropped in order to fill the shape. The rendered size of\nthe image will be the same as that of the original shape."
- ]
- },
- "pageObjectIds": {
- "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "containsText": {
- "description": "If set, this request will replace all of the shapes that contain the\ngiven text.",
- "$ref": "SubstringMatchCriteria"
- }
- },
- "id": "ReplaceAllShapesWithImageRequest"
- },
- "Shadow": {
- "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",
- "properties": {
- "type": {
- "description": "The type of the shadow.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified shadow type.",
- "Outer shadow."
- ],
- "enum": [
- "SHADOW_TYPE_UNSPECIFIED",
- "OUTER"
+ "Unspecified mode.",
+ "Applies the new AffineTransform matrix to the existing one, and\nreplaces the existing one with the resulting concatenation.",
+ "Replaces the existing AffineTransform matrix with the new one."
]
},
"transform": {
"$ref": "AffineTransform",
- "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
+ "description": "The input transform matrix used to update the page element."
},
- "alignment": {
- "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Top left.",
- "Top center.",
- "Top right.",
- "Left center.",
- "Center.",
- "Right center.",
- "Bottom left.",
- "Bottom center.",
- "Bottom right."
- ],
- "enum": [
- "RECTANGLE_POSITION_UNSPECIFIED",
- "TOP_LEFT",
- "TOP_CENTER",
- "TOP_RIGHT",
- "LEFT_CENTER",
- "CENTER",
- "RIGHT_CENTER",
- "BOTTOM_LEFT",
- "BOTTOM_CENTER",
- "BOTTOM_RIGHT"
- ]
- },
- "alpha": {
- "format": "float",
- "description": "The alpha of the shadow's color, from 0.0 to 1.0.",
- "type": "number"
- },
- "color": {
- "description": "The shadow color value.",
- "$ref": "OpaqueColor"
- },
- "rotateWithShape": {
- "description": "Whether the shadow should rotate with the shape.",
- "type": "boolean"
- },
- "propertyState": {
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The shadow property state.\n\nUpdating the the shadow on a page element will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no shadow on a page element, set this field to `NOT_RENDERED`. In this\ncase, any other shadow fields set in the same request will be ignored."
- },
- "blurRadius": {
- "$ref": "Dimension",
- "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes."
+ "objectId": {
+ "description": "The object ID of the page element to update.",
+ "type": "string"
}
}
},
- "DeleteTableRowRequest": {
- "description": "Deletes a row from a table.",
+ "DeleteTextRequest": {
+ "description": "Deletes text from a shape or a table cell.",
"type": "object",
"properties": {
+ "textRange": {
+ "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units.",
+ "$ref": "Range"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table from which the text will be deleted.",
+ "type": "string"
+ },
"cellLocation": {
"$ref": "TableCellLocation",
- "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted."
- },
- "tableObjectId": {
- "type": "string",
- "description": "The table to delete rows from."
+ "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": "DeleteTableRowRequest"
+ "id": "DeleteTextRequest"
},
- "Bullet": {
- "id": "Bullet",
- "description": "Describes the bullet of a paragraph.",
+ "DeleteObjectRequest": {
+ "description": "Deletes an object, either pages or\npage elements, from the\npresentation.",
"type": "object",
"properties": {
- "glyph": {
- "description": "The rendered bullet glyph for this paragraph.",
- "type": "string"
- },
- "nestingLevel": {
- "format": "int32",
- "description": "The nesting level of this paragraph in the list.",
- "type": "integer"
- },
- "bulletStyle": {
- "description": "The paragraph specific text style applied to this bullet.",
- "$ref": "TextStyle"
- },
- "listId": {
- "description": "The ID of the list this paragraph belongs to.",
+ "objectId": {
+ "description": "The object ID of the page or page element to delete.\n\nIf after a delete operation a group contains\nonly 1 or no page elements, the group is also deleted.\n\nIf a placeholder is deleted on a layout, any empty inheriting shapes are\nalso deleted.",
"type": "string"
}
- }
+ },
+ "id": "DeleteObjectRequest"
},
- "OutlineFill": {
- "description": "The fill of the outline.",
+ "Dimension": {
+ "description": "A magnitude in a single direction in the specified units.",
"type": "object",
"properties": {
+ "unit": {
+ "description": "The units for magnitude.",
+ "type": "string",
+ "enumDescriptions": [
+ "The units are unknown.",
+ "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
+ "A point, 1/72 of an inch."
+ ],
+ "enum": [
+ "UNIT_UNSPECIFIED",
+ "EMU",
+ "PT"
+ ]
+ },
+ "magnitude": {
+ "format": "double",
+ "description": "The magnitude.",
+ "type": "number"
+ }
+ },
+ "id": "Dimension"
+ },
+ "TextElement": {
+ "type": "object",
+ "properties": {
+ "textRun": {
+ "$ref": "TextRun",
+ "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs."
+ },
+ "autoText": {
+ "$ref": "AutoText",
+ "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time."
+ },
+ "paragraphMarker": {
+ "$ref": "ParagraphMarker",
+ "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap."
+ },
+ "endIndex": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits."
+ },
+ "startIndex": {
+ "format": "int32",
+ "description": "The zero-based start index of this text element, in Unicode code units.",
+ "type": "integer"
+ }
+ },
+ "id": "TextElement",
+ "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell."
+ },
+ "LineFill": {
+ "properties": {
"solidFill": {
"description": "Solid color fill.",
"$ref": "SolidFill"
}
},
- "id": "OutlineFill"
- },
- "TableCellLocation": {
- "description": "A location of a single table cell within a table.",
- "type": "object",
- "properties": {
- "columnIndex": {
- "format": "int32",
- "description": "The 0-based column index.",
- "type": "integer"
- },
- "rowIndex": {
- "format": "int32",
- "description": "The 0-based row index.",
- "type": "integer"
- }
- },
- "id": "TableCellLocation"
- },
- "CreateLineResponse": {
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the created line."
- }
- },
- "id": "CreateLineResponse",
- "description": "The result of creating a line.",
+ "id": "LineFill",
+ "description": "The fill of the line.",
"type": "object"
},
- "ReplaceAllTextResponse": {
- "description": "The result of replacing text.",
+ "VideoProperties": {
+ "description": "The properties of the Video.",
"type": "object",
"properties": {
- "occurrencesChanged": {
- "format": "int32",
- "description": "The number of occurrences changed by replacing all text.",
- "type": "integer"
+ "outline": {
+ "$ref": "Outline",
+ "description": "The outline of the video. The default outline matches the defaults for new\nvideos created in the Slides editor."
}
},
- "id": "ReplaceAllTextResponse"
+ "id": "VideoProperties"
}
},
- "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "canonicalName": "Slides",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/presentations.readonly": {
- "description": "View your Google Slides presentations"
- },
- "https://www.googleapis.com/auth/spreadsheets.readonly": {
- "description": "View your Google Spreadsheets"
- },
- "https://www.googleapis.com/auth/drive": {
- "description": "View and manage the files in your Google Drive"
- },
- "https://www.googleapis.com/auth/drive.readonly": {
- "description": "View the files in your Google Drive"
- },
- "https://www.googleapis.com/auth/spreadsheets": {
- "description": "View and manage your spreadsheets in Google Drive"
- },
- "https://www.googleapis.com/auth/presentations": {
- "description": "View and manage your Google Slides presentations"
- }
- }
- }
- },
- "rootUrl": "https://slides.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "slides",
- "batchPath": "batch",
- "title": "Google Slides API",
- "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.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1/presentations/{presentationsId}",
- "id": "slides.presentations.get",
- "path": "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "presentationId"
- ],
- "response": {
- "$ref": "BatchUpdatePresentationResponse"
- },
- "parameters": {
- "presentationId": {
- "location": "path",
- "description": "The presentation to apply the updates to.",
- "type": "string",
- "required": true
- }
- },
- "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"
- ],
- "flatPath": "v1/presentations/{presentationId}:batchUpdate"
- },
- "create": {
- "flatPath": "v1/presentations",
- "id": "slides.presentations.create",
- "path": "v1/presentations",
- "request": {
- "$ref": "Presentation"
- },
- "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation.",
- "response": {
- "$ref": "Presentation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/presentations"
- ],
- "parameters": {}
- }
- },
- "resources": {
- "pages": {
- "methods": {
- "getThumbnail": {
- "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image.",
- "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": {
- "pageObjectId": {
- "description": "The object ID of the page whose thumbnail to retrieve.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "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"
- },
- "thumbnailProperties.mimeType": {
- "type": "string",
- "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."
- },
- "presentationId": {
- "location": "path",
- "description": "The ID of the presentation to retrieve.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
- "path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
- "id": "slides.presentations.pages.getThumbnail"
- },
- "get": {
- "response": {
- "$ref": "Page"
- },
- "parameterOrder": [
- "presentationId",
- "pageObjectId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ],
- "parameters": {
- "pageObjectId": {
- "location": "path",
- "description": "The object ID of the page to retrieve.",
- "type": "string",
- "required": true
- },
- "presentationId": {
- "location": "path",
- "description": "The ID of the presentation to retrieve.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "id": "slides.presentations.pages.get",
- "path": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "description": "Gets the latest version of the specified page in the presentation."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "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": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://slides.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "An API for creating and editing Google Slides presentations.",
- "servicePath": "",
- "basePath": ""
+ "protocol": "rest"
}
diff --git a/sourcerepo/v1/sourcerepo-api.json b/sourcerepo/v1/sourcerepo-api.json
index 622567c..01f8dd0 100644
--- a/sourcerepo/v1/sourcerepo-api.json
+++ b/sourcerepo/v1/sourcerepo-api.json
@@ -1,27 +1,118 @@
{
- "version": "v1",
- "baseUrl": "https://sourcerepo.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Access source code repositories hosted by Google.",
- "basePath": "",
- "revision": "20170528",
- "documentationLink": "https://cloud.google.com/source-repositories/docs/apis",
"id": "sourcerepo:v1",
+ "documentationLink": "https://cloud.google.com/source-repositories/docs/apis",
+ "revision": "20170528",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "Repo": {
+ "AuditConfig": {
+ "id": "AuditConfig",
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
- "name": {
- "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`. The repo name may contain slashes.\neg, `projects/myproject/repos/name/with/slash`",
+ "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"
},
- "mirrorConfig": {
- "$ref": "MirrorConfig",
- "description": "How this repository mirrors a repository managed by another service."
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
},
+ "exemptedMembers": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "type": "string"
+ },
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "CloudAuditOptions": {
+ "type": "object",
+ "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",
+ "description": "Write a Cloud Audit log"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "type": "string",
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
+ }
+ },
+ "id": "Binding"
+ },
+ "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": {
+ "id": "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"
+ },
+ "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"
+ }
+ }
+ },
+ "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"
@@ -30,47 +121,47 @@
"format": "int64",
"description": "The disk usage of the repo, in bytes.\nOnly returned by GetRepo.",
"type": "string"
- }
- },
- "id": "Repo",
- "description": "A repository (or repo) is a Git repository storing versioned source content."
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "ListReposResponse": {
- "properties": {
- "nextPageToken": {
- "type": "string",
- "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."
},
- "repos": {
- "items": {
- "$ref": "Repo"
- },
- "type": "array",
- "description": "The listed repos."
+ "name": {
+ "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`. The repo name may contain slashes.\neg, `projects/myproject/repos/name/with/slash`",
+ "type": "string"
+ },
+ "mirrorConfig": {
+ "description": "How this repository mirrors a repository managed by another service.",
+ "$ref": "MirrorConfig"
}
},
- "id": "ListReposResponse",
- "description": "Response for ListRepos. The size is not set in the returned repositories.",
- "type": "object"
+ "id": "Repo"
},
"Condition": {
"description": "A condition to be met.",
"type": "object",
"properties": {
+ "values": {
+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "iam": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default non-attribute.",
+ "Either principal or (if present) authority selector.",
+ "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
+ "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
+ "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
+ ],
+ "enum": [
+ "NO_ATTR",
+ "AUTHORITY",
+ "ATTRIBUTION",
+ "APPROVER",
+ "JUSTIFICATION_TYPE"
+ ],
+ "description": "Trusted attributes supplied by the IAM system."
+ },
"op": {
"enumDescriptions": [
"Default no-op.",
@@ -92,12 +183,8 @@
"type": "string"
},
"svc": {
- "description": "Trusted attributes discharged by the service.",
- "type": "string"
- },
- "value": {
- "description": "DEPRECATED. Use 'values' instead.",
- "type": "string"
+ "type": "string",
+ "description": "Trusted attributes discharged by the service."
},
"sys": {
"enumDescriptions": [
@@ -117,36 +204,46 @@
"description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
"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.",
+ "value": {
+ "description": "DEPRECATED. Use 'values' instead.",
+ "type": "string"
+ }
+ },
+ "id": "Condition"
+ },
+ "ListReposResponse": {
+ "description": "Response for ListRepos. The size is not set in the returned repositories.",
+ "type": "object",
+ "properties": {
+ "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"
},
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "repos": {
+ "description": "The listed repos.",
+ "items": {
+ "$ref": "Repo"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListReposResponse"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
- "id": "Condition"
+ "id": "TestIamPermissionsResponse"
},
"CounterOptions": {
- "id": "CounterOptions",
"description": "Options for counters",
"type": "object",
"properties": {
@@ -155,17 +252,24 @@
"type": "string"
},
"metric": {
- "type": "string",
- "description": "The metric to update."
+ "description": "The metric to update.",
+ "type": "string"
}
- }
+ },
+ "id": "CounterOptions"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
"type": "object",
"properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"logType": {
- "description": "The log type that this config enables.",
"type": "string",
"enumDescriptions": [
"Default case. Should never be this.",
@@ -178,19 +282,14 @@
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
- ]
- },
- "exemptedMembers": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members."
+ ],
+ "description": "The log type that this config enables."
}
},
"id": "AuditLogConfig"
},
"Rule": {
+ "id": "Rule",
"description": "A rule to be applied in a Policy.",
"type": "object",
"properties": {
@@ -247,14 +346,13 @@
]
},
"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).",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "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)."
}
- },
- "id": "Rule"
+ }
},
"LogConfig": {
"description": "Specifies what kind of log the caller must write",
@@ -269,8 +367,8 @@
"description": "Cloud audit options."
},
"counter": {
- "$ref": "CounterOptions",
- "description": "Counter options."
+ "description": "Counter options.",
+ "$ref": "CounterOptions"
}
},
"id": "LogConfig"
@@ -279,18 +377,25 @@
"type": "object",
"properties": {
"permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."
}
},
"id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method."
},
"Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
"properties": {
+ "etag": {
+ "format": "byte",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "type": "string"
+ },
"iamOwned": {
"type": "boolean"
},
@@ -319,145 +424,34 @@
"$ref": "Binding"
},
"type": "array"
- },
- "etag": {
- "format": "byte",
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "type": "string"
}
},
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object"
+ "id": "Policy"
},
"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": {
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "items": {
- "$ref": "AuditLogConfig"
- },
- "type": "array"
- },
- "exemptedMembers": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- }
- },
- "id": "AuditConfig"
- },
- "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": {
- "format": "google-fieldmask",
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "type": "string"
- }
- },
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
- },
- "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"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
- },
- "MirrorConfig": {
- "type": "object",
- "properties": {
- "deployKeyId": {
- "type": "string",
- "description": "ID of the SSH deploy key at the other hosting service.\nRemoving this key from the other service would deauthorize\nGoogle Cloud Source Repositories from mirroring."
- },
- "url": {
- "description": "URL of the main repository at the other hosting service.",
- "type": "string"
- },
- "webhookId": {
- "description": "ID of the webhook listening to updates to trigger mirroring.\nRemoving this webook from the other hosting service will stop\nGoogle Cloud Source Repositories from receiving notifications,\nand thereby disabling mirroring.",
- "type": "string"
- }
- },
- "id": "MirrorConfig",
- "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket."
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"canonicalName": "Cloud Source Repositories",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/source.read_only": {
+ "description": "View the contents of your source code repositories"
+ },
"https://www.googleapis.com/auth/source.read_write": {
"description": "Manage the contents of your source code repositories"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/source.read_only": {
- "description": "View the contents of your source code repositories"
}
}
}
@@ -474,9 +468,6 @@
"repos": {
"methods": {
"testIamPermissions": {
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:testIamPermissions",
- "id": "sourcerepo.projects.repos.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
@@ -495,22 +486,25 @@
],
"parameters": {
"resource": {
- "location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/repos/.+$"
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:testIamPermissions",
+ "id": "sourcerepo.projects.repos.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions"
},
"delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/source.read_only",
@@ -526,27 +520,26 @@
}
},
"flatPath": "v1/projects/{projectsId}/repos/{reposId}",
- "path": "v1/{+name}",
"id": "sourcerepo.projects.repos.delete",
+ "path": "v1/{+name}",
"description": "Deletes a repo."
},
"list": {
- "flatPath": "v1/projects/{projectsId}/repos",
- "path": "v1/{+name}/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",
"response": {
"$ref": "ListReposResponse"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"parameters": {
"pageToken": {
- "location": "query",
"description": "Resume listing repositories where a prior ListReposResponse\nleft off. This is an opaque token that must be obtained from\na recent, prior ListReposResponse's next_page_token field.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"name": {
"location": "path",
@@ -566,50 +559,26 @@
"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"
},
- "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`.",
+ "setIamPolicy": {
"request": {
- "$ref": "Repo"
+ "$ref": "SetIamPolicyRequest"
},
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"httpMethod": "POST",
"parameterOrder": [
- "parent"
+ "resource"
],
"response": {
- "$ref": "Repo"
- },
- "parameters": {
- "parent": {
- "description": "The project in which to create the repo. Values are of the form\n`projects/\u003cproject\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
+ "$ref": "Policy"
},
"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",
- "path": "v1/{+parent}/repos",
- "id": "sourcerepo.projects.repos.create"
- },
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
"parameters": {
"resource": {
"type": "string",
@@ -619,16 +588,42 @@
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field."
}
},
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "sourcerepo.projects.repos.setIamPolicy"
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/repos",
+ "path": "v1/{+parent}/repos",
+ "id": "sourcerepo.projects.repos.create",
+ "request": {
+ "$ref": "Repo"
+ },
+ "description": "Creates a repo in the given project with the given name.\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.",
+ "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"
],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:setIamPolicy",
- "id": "sourcerepo.projects.repos.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project in which to create the repo. Values are of the form\n`projects/\u003cproject\u003e`.",
+ "type": "string",
+ "required": true
+ }
+ }
},
"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"
},
@@ -636,51 +631,50 @@
"resource"
],
"httpMethod": "GET",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/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}:getIamPolicy",
+ "id": "sourcerepo.projects.repos.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
+ },
+ "get": {
+ "response": {
+ "$ref": "Repo"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"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": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/repos/.+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy",
- "id": "sourcerepo.projects.repos.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "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": {
- "parameters": {
"name": {
- "location": "path",
"description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/repos/.+$"
+ "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}",
"id": "sourcerepo.projects.repos.get",
"path": "v1/{+name}",
- "description": "Returns information about a repo.",
- "response": {
- "$ref": "Repo"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET"
+ "description": "Returns information about a repo."
}
}
}
@@ -694,39 +688,39 @@
"type": "string"
},
"prettyPrint": {
- "default": "true",
- "type": "boolean",
"location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "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"
- },
- "$.xgafv": {
"location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "fields": {
"type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
+ "$.xgafv": {
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
"alt": {
"type": "string",
"enumDescriptions": [
@@ -744,35 +738,41 @@
]
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
"type": "string",
"location": "query"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
+ "type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
+ "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://sourcerepo.googleapis.com/",
+ "servicePath": "",
+ "description": "Access source code repositories hosted by Google.",
+ "kind": "discovery#restDescription",
+ "basePath": ""
}
diff --git a/spanner/v1/spanner-api.json b/spanner/v1/spanner-api.json
index 621e96a..df02c56 100644
--- a/spanner/v1/spanner-api.json
+++ b/spanner/v1/spanner-api.json
@@ -1,14 +1,48 @@
{
- "kind": "discovery#restDescription",
- "description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.",
- "servicePath": "",
- "basePath": "",
- "revision": "20170726",
- "documentationLink": "https://cloud.google.com/spanner/",
- "id": "spanner:v1",
- "discoveryVersion": "v1",
- "version_module": "True",
"schemas": {
+ "Transaction": {
+ "properties": {
+ "id": {
+ "format": "byte",
+ "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.",
+ "type": "string"
+ },
+ "readTimestamp": {
+ "format": "google-datetime",
+ "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.",
+ "type": "string"
+ }
+ },
+ "id": "Transaction",
+ "description": "A transaction.",
+ "type": "object"
+ },
+ "UpdateDatabaseDdlMetadata": {
+ "properties": {
+ "database": {
+ "description": "The database being modified.",
+ "type": "string"
+ },
+ "statements": {
+ "description": "For an update this list contains all the statements. For an\nindividual statement, this list contains only that statement.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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]`.",
+ "items": {
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "UpdateDatabaseDdlMetadata",
+ "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
+ "type": "object"
+ },
"CounterOptions": {
"description": "Options for counters",
"type": "object",
@@ -39,8 +73,6 @@
"id": "QueryPlan"
},
"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.",
@@ -50,45 +82,45 @@
"type": "array"
}
},
- "id": "StructType"
+ "id": "StructType",
+ "description": "`StructType` defines the fields of a STRUCT type.",
+ "type": "object"
},
"Field": {
- "description": "Message representing a single field of a struct.",
- "type": "object",
"properties": {
"name": {
"description": "The name of the field. For reads, this is the column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the\nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain\nmultiple fields with the same name.",
"type": "string"
},
"type": {
- "$ref": "Type",
- "description": "The type of the field."
+ "description": "The type of the field.",
+ "$ref": "Type"
}
},
- "id": "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": {
"queryPlan": {
- "description": "QueryPlan for the query associated with this result.",
- "$ref": "QueryPlan"
+ "$ref": "QueryPlan",
+ "description": "QueryPlan for the query associated with this result."
},
"queryStats": {
- "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "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"
+ "id": "ResultSetStats",
+ "description": "Additional statistics about a ResultSet or PartialResultSet.",
+ "type": "object"
},
"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.",
@@ -98,7 +130,34 @@
"type": "array"
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "AuthorizationLoggingOptions": {
+ "properties": {
+ "permissionType": {
+ "enum": [
+ "PERMISSION_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "ADMIN_WRITE",
+ "DATA_READ",
+ "DATA_WRITE"
+ ],
+ "description": "The type of the permission that was checked.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default. Should not be used.",
+ "A read of admin (meta) data.",
+ "A write of admin (meta) data.",
+ "A read of standard data.",
+ "A write of standard data."
+ ]
+ }
+ },
+ "id": "AuthorizationLoggingOptions",
+ "description": "Authorization-related information used by Cloud Audit Logging.",
+ "type": "object"
},
"CommitResponse": {
"description": "The response for Commit.",
@@ -112,31 +171,6 @@
},
"id": "CommitResponse"
},
- "AuthorizationLoggingOptions": {
- "description": "Authorization-related information used by Cloud Audit Logging.",
- "type": "object",
- "properties": {
- "permissionType": {
- "enumDescriptions": [
- "Default. Should not be used.",
- "A read of admin (meta) data.",
- "A write of admin (meta) data.",
- "A read of standard data.",
- "A write of standard data."
- ],
- "enum": [
- "PERMISSION_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "ADMIN_WRITE",
- "DATA_READ",
- "DATA_WRITE"
- ],
- "description": "The type of the permission that was checked.",
- "type": "string"
- }
- },
- "id": "AuthorizationLoggingOptions"
- },
"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",
@@ -146,22 +180,10 @@
"description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields."
},
"arrayElementType": {
- "$ref": "Type",
- "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."
+ "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",
@@ -175,7 +197,19 @@
"STRUCT"
],
"description": "Required. The TypeCode for this type.",
- "type": "string"
+ "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"
@@ -184,33 +218,6 @@
"description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
"type": "object",
"properties": {
- "shortRepresentation": {
- "$ref": "ShortRepresentation",
- "description": "Condensed representation for SCALAR nodes."
- },
- "index": {
- "format": "int32",
- "description": "The `PlanNode`'s index in node list.",
- "type": "integer"
- },
- "kind": {
- "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."
- ],
- "enum": [
- "KIND_UNSPECIFIED",
- "RELATIONAL",
- "SCALAR"
- ]
- },
- "displayName": {
- "description": "The display name for the node.",
- "type": "string"
- },
"childLinks": {
"description": "List of child node `index`es and their relationship to this parent.",
"items": {
@@ -219,24 +226,75 @@
"type": "array"
},
"metadata": {
- "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "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": {
- "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",
"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": {
+ "format": "int32",
+ "description": "The `PlanNode`'s index in node list.",
+ "type": "integer"
+ },
+ "displayName": {
+ "description": "The display name for the node.",
+ "type": "string"
+ },
+ "kind": {
+ "enum": [
+ "KIND_UNSPECIFIED",
+ "RELATIONAL",
+ "SCALAR"
+ ],
+ "description": "Used to determine the type of node. May be needed for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\nSCALAR node, it will have a condensed representation\nwhich can be used to directly embed a description of the node in its\nparent.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Denotes a Relational operator node in the expression tree. Relational\noperators represent iterative processing of rows during query execution.\nFor example, a `TableScan` operation that reads rows from a table.",
+ "Denotes a Scalar node in the expression tree. Scalar nodes represent\nnon-iterable entities in the query plan. For example, constants or\narithmetic operators appearing inside predicate expressions or references\nto column names."
+ ]
}
},
"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 AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuditConfig"
+ },
"CreateInstanceMetadata": {
"description": "Metadata type for the operation returned by\nCreateInstance.",
"type": "object",
@@ -263,30 +321,6 @@
},
"id": "CreateInstanceMetadata"
},
- "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",
- "items": {
- "$ref": "AuditLogConfig"
- },
- "type": "array"
- },
- "exemptedMembers": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- }
- },
- "id": "AuditConfig"
- },
"ChildLink": {
"description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
"type": "object",
@@ -311,6 +345,10 @@
"description": "Write a Cloud Audit log",
"type": "object",
"properties": {
+ "authorizationLoggingOptions": {
+ "$ref": "AuthorizationLoggingOptions",
+ "description": "Information used by the Cloud Audit Logging pipeline."
+ },
"logName": {
"enumDescriptions": [
"Default. Should not be used.",
@@ -324,26 +362,12 @@
],
"description": "The log_name to populate in the Cloud Audit Record.",
"type": "string"
- },
- "authorizationLoggingOptions": {
- "$ref": "AuthorizationLoggingOptions",
- "description": "Information used by the Cloud Audit Logging pipeline."
}
},
"id": "CloudAuditOptions"
},
"Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
"properties": {
- "description": {
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "expression": {
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
- "type": "string"
- },
"location": {
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type": "string"
@@ -351,28 +375,36 @@
"title": {
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
"type": "string"
+ },
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
+ "type": "string"
}
},
- "id": "Expr"
+ "id": "Expr",
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object"
},
"Delete": {
"description": "Arguments to delete operations.",
"type": "object",
"properties": {
+ "keySet": {
+ "description": "Required. The primary keys of the rows within table to delete.",
+ "$ref": "KeySet"
+ },
"table": {
"description": "Required. The table whose rows will be deleted.",
"type": "string"
- },
- "keySet": {
- "$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": {
"mutations": {
"description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
@@ -382,8 +414,8 @@
"type": "array"
},
"singleUseTransaction": {
- "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead.",
- "$ref": "TransactionOptions"
+ "$ref": "TransactionOptions",
+ "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead."
},
"transactionId": {
"format": "byte",
@@ -391,22 +423,22 @@
"type": "string"
}
},
- "id": "CommitRequest"
+ "id": "CommitRequest",
+ "description": "The request for Commit.",
+ "type": "object"
},
"BeginTransactionRequest": {
"description": "The request for BeginTransaction.",
"type": "object",
"properties": {
"options": {
- "description": "Required. Options for the new transaction.",
- "$ref": "TransactionOptions"
+ "$ref": "TransactionOptions",
+ "description": "Required. Options for the new transaction."
}
},
"id": "BeginTransactionRequest"
},
"ListInstanceConfigsResponse": {
- "description": "The response for ListInstanceConfigs.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",
@@ -420,7 +452,15 @@
"type": "array"
}
},
- "id": "ListInstanceConfigsResponse"
+ "id": "ListInstanceConfigsResponse",
+ "description": "The response for ListInstanceConfigs.",
+ "type": "object"
+ },
+ "GetIamPolicyRequest": {
+ "properties": {},
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
@@ -436,30 +476,19 @@
},
"id": "TestIamPermissionsResponse"
},
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "Rule": {
- "description": "A rule to be applied in a Policy.",
+ "CreateDatabaseMetadata": {
+ "description": "Metadata type for the operation returned by\nCreateDatabase.",
"type": "object",
"properties": {
- "logConfig": {
- "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
- "items": {
- "$ref": "LogConfig"
- },
- "type": "array"
- },
- "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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
+ "database": {
+ "description": "The database being created.",
+ "type": "string"
+ }
+ },
+ "id": "CreateDatabaseMetadata"
+ },
+ "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.",
"items": {
@@ -504,36 +533,41 @@
"$ref": "Condition"
},
"type": "array"
+ },
+ "logConfig": {
+ "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
+ "items": {
+ "$ref": "LogConfig"
+ },
+ "type": "array"
+ },
+ "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "Rule"
- },
- "CreateDatabaseMetadata": {
- "description": "Metadata type for the operation returned by\nCreateDatabase.",
- "type": "object",
- "properties": {
- "database": {
- "description": "The database being created.",
- "type": "string"
- }
- },
- "id": "CreateDatabaseMetadata"
+ "id": "Rule",
+ "description": "A rule to be applied in a Policy.",
+ "type": "object"
},
"LogConfig": {
"description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
"type": "object",
"properties": {
+ "counter": {
+ "description": "Counter options.",
+ "$ref": "CounterOptions"
+ },
"dataAccess": {
"$ref": "DataAccessOptions",
"description": "Data access options."
},
"cloudAudit": {
- "description": "Cloud audit options.",
- "$ref": "CloudAuditOptions"
- },
- "counter": {
- "description": "Counter options.",
- "$ref": "CounterOptions"
+ "$ref": "CloudAuditOptions",
+ "description": "Cloud audit options."
}
},
"id": "LogConfig"
@@ -588,23 +622,21 @@
"description": "The response for ListInstances.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
+ "type": "string"
+ },
"instances": {
"description": "The list of requested instances.",
"items": {
"$ref": "Instance"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
- "type": "string"
}
},
"id": "ListInstancesResponse"
},
"ShortRepresentation": {
- "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
- "type": "object",
"properties": {
"description": {
"description": "A string representation of the expression subtree rooted at this node.",
@@ -619,19 +651,21 @@
"type": "object"
}
},
- "id": "ShortRepresentation"
+ "id": "ShortRepresentation",
+ "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
+ "type": "object"
},
"InstanceConfig": {
"description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.",
"type": "object",
"properties": {
- "displayName": {
- "description": "The name of this instance configuration as it appears in UIs.",
- "type": "string"
- },
"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"
@@ -653,10 +687,10 @@
"id": "UpdateInstanceRequest"
},
"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"
},
"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`.",
@@ -692,54 +726,23 @@
"id": "CreateDatabaseRequest"
},
"CreateInstanceRequest": {
- "description": "The request for CreateInstance.",
- "type": "object",
"properties": {
"instanceId": {
"description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength.",
"type": "string"
},
"instance": {
- "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`.",
- "$ref": "Instance"
+ "$ref": "Instance",
+ "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`."
}
},
- "id": "CreateInstanceRequest"
+ "id": "CreateInstanceRequest",
+ "description": "The request for CreateInstance.",
+ "type": "object"
},
"Condition": {
- "description": "A condition to be met.",
- "type": "object",
"properties": {
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "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.",
- "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).",
- "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"
- ]
- },
"op": {
- "description": "An operator to apply the subject with.",
- "type": "string",
"enumDescriptions": [
"Default no-op.",
"DEPRECATED. Use IN instead.",
@@ -755,19 +758,15 @@
"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": {
- "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",
@@ -781,14 +780,47 @@
"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'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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).",
+ "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."
]
}
},
- "id": "Condition"
+ "id": "Condition",
+ "description": "A condition to be met.",
+ "type": "object"
},
"AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
@@ -798,12 +830,6 @@
"type": "array"
},
"logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
@@ -811,20 +837,21 @@
"DATA_READ"
],
"description": "The log type that this config enables.",
- "type": "string"
+ "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"
+ "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": {
- "description": "Message type to initiate a read-only transaction.",
- "type": "object",
"properties": {
- "minReadTimestamp": {
- "format": "google-datetime",
- "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.",
- "type": "string"
- },
"maxStaleness": {
"format": "google-duration",
"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.",
@@ -847,17 +874,30 @@
"strong": {
"description": "Read at a timestamp where all previously committed transactions\nare visible.",
"type": "boolean"
+ },
+ "minReadTimestamp": {
+ "format": "google-datetime",
+ "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.",
+ "type": "string"
}
},
- "id": "ReadOnly"
+ "id": "ReadOnly",
+ "description": "Message type to initiate a read-only transaction.",
+ "type": "object"
},
"ExecuteSqlRequest": {
"description": "The request for ExecuteSql and\nExecuteStreamingSql.",
"type": "object",
"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": {
- "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.",
@@ -867,11 +907,13 @@
"NORMAL",
"PLAN",
"PROFILE"
- ]
+ ],
+ "description": "Used to control the amount of debugging information returned in\nResultSetStats.",
+ "type": "string"
},
"transaction": {
- "$ref": "TransactionSelector",
- "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
+ "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency.",
+ "$ref": "TransactionSelector"
},
"resumeToken": {
"format": "byte",
@@ -879,31 +921,31 @@
"type": "string"
},
"paramTypes": {
- "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
- "type": "object",
"additionalProperties": {
"$ref": "Type"
- }
+ },
+ "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
+ "type": "object"
},
"sql": {
"description": "Required. The SQL query string.",
"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"
}
},
"id": "ExecuteSqlRequest"
},
"Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
"properties": {
+ "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.",
+ "items": {
+ "$ref": "Rule"
+ },
+ "type": "array"
+ },
"version": {
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
@@ -927,29 +969,16 @@
"format": "byte",
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"type": "string"
- },
- "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.",
- "items": {
- "$ref": "Rule"
- },
- "type": "array"
}
},
- "id": "Policy"
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object"
},
"ReadRequest": {
"description": "The request for Read and\nStreamingRead.",
"type": "object",
"properties": {
- "limit": {
- "format": "int64",
- "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
- "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"
@@ -966,8 +995,8 @@
"type": "array"
},
"transaction": {
- "$ref": "TransactionSelector",
- "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
+ "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency.",
+ "$ref": "TransactionSelector"
},
"resumeToken": {
"format": "byte",
@@ -977,6 +1006,11 @@
"table": {
"description": "Required. The name of the table in the database to be read.",
"type": "string"
+ },
+ "limit": {
+ "format": "int64",
+ "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
+ "type": "string"
}
},
"id": "ReadRequest"
@@ -1022,12 +1056,26 @@
"id": "DataAccessOptions"
},
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
"properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
@@ -1036,55 +1084,18 @@
},
"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"
- },
- "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.",
- "items": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "type": "array"
- },
- "metadata": {
- "$ref": "ResultSetMetadata",
- "description": "Metadata about the result set, such as row type information."
- }
- },
- "id": "ResultSet"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -1100,21 +1111,42 @@
"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"
+ "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"
+ },
+ "ResultSet": {
+ "properties": {
+ "rows": {
+ "description": "Each element in `rows` is a row whose format is defined by\nmetadata.row_type. The ith element\nin each row matches the ith field in\nmetadata.row_type. Elements are\nencoded based on type as described\nhere.",
+ "items": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "metadata": {
+ "description": "Metadata about the result set, such as row type information.",
+ "$ref": "ResultSetMetadata"
+ },
+ "stats": {
+ "$ref": "ResultSetStats",
+ "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode."
+ }
+ },
+ "id": "ResultSet",
+ "description": "Results from Read or\nExecuteSql.",
+ "type": "object"
},
"Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
"properties": {
"condition": {
- "$ref": "Expr",
- "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
+ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.",
+ "$ref": "Expr"
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
@@ -1128,34 +1160,30 @@
"type": "string"
}
},
- "id": "Binding"
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
},
"UpdateDatabaseDdlRequest": {
- "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.",
- "type": "object",
"properties": {
- "operationId": {
- "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit operation ID simplifies determining\nwhether the statements were executed in the event that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwise lost: the database and\n`operation_id` fields can be combined to form the\nname of the resulting\nlongrunning.Operation: `\u003cdatabase\u003e/operations/\u003coperation_id\u003e`.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begin with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.",
- "type": "string"
- },
"statements": {
"description": "DDL statements to be applied to the database.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "operationId": {
+ "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit operation ID simplifies determining\nwhether the statements were executed in the event that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwise lost: the database and\n`operation_id` fields can be combined to form the\nname of the resulting\nlongrunning.Operation: `\u003cdatabase\u003e/operations/\u003coperation_id\u003e`.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begin with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.",
+ "type": "string"
}
},
- "id": "UpdateDatabaseDdlRequest"
+ "id": "UpdateDatabaseDdlRequest",
+ "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.",
+ "type": "object"
},
"PartialResultSet": {
- "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
- "type": "object",
"properties": {
- "stats": {
- "$ref": "ResultSetStats",
- "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream."
- },
"chunkedValue": {
"description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.",
"type": "boolean"
@@ -1168,21 +1196,34 @@
"type": "array"
},
"metadata": {
- "description": "Metadata about the result set, such as row type information.\nOnly present in the first response.",
- "$ref": "ResultSetMetadata"
+ "$ref": "ResultSetMetadata",
+ "description": "Metadata about the result set, such as row type information.\nOnly present in the first response."
},
"resumeToken": {
"format": "byte",
"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.",
"type": "string"
+ },
+ "stats": {
+ "$ref": "ResultSetStats",
+ "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream."
}
},
- "id": "PartialResultSet"
+ "id": "PartialResultSet",
+ "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
+ "type": "object"
},
"UpdateInstanceMetadata": {
- "description": "Metadata type for the operation returned by\nUpdateInstance.",
- "type": "object",
"properties": {
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The time at which UpdateInstance\nrequest was received.",
+ "type": "string"
+ },
+ "instance": {
+ "$ref": "Instance",
+ "description": "The desired end state of the update."
+ },
"endTime": {
"format": "google-datetime",
"description": "The time at which this operation failed or was completed successfully.",
@@ -1192,22 +1233,13 @@
"format": "google-datetime",
"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.",
"type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The time at which UpdateInstance\nrequest was received.",
- "type": "string"
- },
- "instance": {
- "$ref": "Instance",
- "description": "The desired end state of the update."
}
},
- "id": "UpdateInstanceMetadata"
+ "id": "UpdateInstanceMetadata",
+ "description": "Metadata type for the operation returned by\nUpdateInstance.",
+ "type": "object"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -1221,15 +1253,17 @@
"type": "array"
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"ResultSetMetadata": {
"description": "Metadata about a ResultSet or PartialResultSet.",
"type": "object",
"properties": {
"rowType": {
- "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name\": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]",
- "$ref": "StructType"
+ "$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.",
@@ -1239,63 +1273,29 @@
"id": "ResultSetMetadata"
},
"TransactionSelector": {
- "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.",
- "type": "object",
"properties": {
+ "id": {
+ "format": "byte",
+ "description": "Execute the read or SQL query in a previously-started transaction.",
+ "type": "string"
+ },
"singleUse": {
"description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query.",
"$ref": "TransactionOptions"
},
"begin": {
- "$ref": "TransactionOptions",
- "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction."
- },
- "id": {
- "format": "byte",
- "description": "Execute the read or SQL query in a previously-started transaction.",
- "type": "string"
+ "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction.",
+ "$ref": "TransactionOptions"
}
},
- "id": "TransactionSelector"
- },
- "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": {
- "insertOrUpdate": {
- "$ref": "Write",
- "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved."
- },
- "insert": {
- "$ref": "Write",
- "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."
- },
- "update": {
- "description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`.",
- "$ref": "Write"
- },
- "replace": {
- "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Unlike insert_or_update, this means any values not\nexplicitly written become `NULL`.",
- "$ref": "Write"
- },
- "delete": {
- "$ref": "Delete",
- "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."
- }
- },
- "id": "Mutation"
+ "id": "TransactionSelector",
+ "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.",
+ "type": "object"
},
"KeySet": {
"description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.",
"type": "object",
"properties": {
- "ranges": {
- "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
- "items": {
- "$ref": "KeyRange"
- },
- "type": "array"
- },
"all": {
"description": "For convenience `all` can be set to `true` to indicate that this\n`KeySet` matches all keys in the table or index. Note that any keys\nspecified in `keys` or `ranges` are only yielded once.",
"type": "boolean"
@@ -1309,14 +1309,46 @@
"type": "array"
},
"type": "array"
+ },
+ "ranges": {
+ "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
+ "items": {
+ "$ref": "KeyRange"
+ },
+ "type": "array"
}
},
"id": "KeySet"
},
- "GetDatabaseDdlResponse": {
- "description": "The response for GetDatabaseDdl.",
+ "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"
+ },
+ "insertOrUpdate": {
+ "$ref": "Write",
+ "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved."
+ },
+ "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"
+ },
+ "update": {
+ "description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`.",
+ "$ref": "Write"
+ },
+ "replace": {
+ "$ref": "Write",
+ "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Unlike insert_or_update, this means any values not\nexplicitly written become `NULL`."
+ }
+ },
+ "id": "Mutation"
+ },
+ "GetDatabaseDdlResponse": {
+ "properties": {
"statements": {
"description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.",
"items": {
@@ -1325,7 +1357,9 @@
"type": "array"
}
},
- "id": "GetDatabaseDdlResponse"
+ "id": "GetDatabaseDdlResponse",
+ "description": "The response for GetDatabaseDdl.",
+ "type": "object"
},
"Database": {
"description": "A Cloud Spanner database.",
@@ -1370,6 +1404,51 @@
},
"id": "ListDatabasesResponse"
},
+ "Instance": {
+ "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"
+ },
+ "nodeCount": {
+ "format": "int32",
+ "description": "Required. The number of nodes allocated to this instance. This may be zero\nin API responses for instances that are not yet in state `READY`.\n\nEach Spanner node can provide up to 10,000 QPS of reads or 2000 QPS of\nwrites (writing single rows at 1KB data per row), and 2 TiB storage.\n\nFor optimal performance, we recommend provisioning enough nodes to keep\noverall CPU utilization under 75%.\n\nA minimum of 3 nodes is recommended for production environments. This\nminimum is required for SLAs to apply to your instance.\n\nNote that Cloud Spanner performance is highly dependent on workload, schema\ndesign, and dataset characteristics. The performance numbers above are\nestimates, and assume [best practices](https://cloud.google.com/spanner/docs/bulk-loading)\nare followed.",
+ "type": "integer"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cloud Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. Cloud Labels can be used to filter collections of\nresources. They can be used to control how resource metrics are aggregated.\nAnd they can be used as arguments to policy management rules (e.g. route,\nfirewall, load balancing, etc.).\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 64 labels can be associated with a given resource.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.\n\nIf you plan to use labels in your own code, please note that additional\ncharacters may be allowed in the future. And so you are advised to use an\ninternal label representation, such as JSON, which doesn't rely upon\nspecific characters being disallowed. For example, representing labels\nas the string: name + \"_\" + value would prove problematic if we were to\nallow \"_\" in a future release.",
+ "type": "object"
+ }
+ },
+ "id": "Instance",
+ "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
+ "type": "object"
+ },
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
@@ -1386,54 +1465,7 @@
},
"id": "SetIamPolicyRequest"
},
- "Instance": {
- "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "Required. The descriptive name for this instance as it appears in UIs.\nMust be unique per project and between 4 and 30 characters in length.",
- "type": "string"
- },
- "nodeCount": {
- "format": "int32",
- "description": "Required. The number of nodes allocated to this instance. This may be zero\nin API responses for instances that are not yet in state `READY`.\n\nEach Spanner node can provide up to 10,000 QPS of reads or 2000 QPS of\nwrites (writing single rows at 1KB data per row), and 2 TiB storage.\n\nFor optimal performance, we recommend provisioning enough nodes to keep\noverall CPU utilization under 75%.\n\nA minimum of 3 nodes is recommended for production environments. This\nminimum is required for SLAs to apply to your instance.\n\nNote that Cloud Spanner performance is highly dependent on workload, schema\ndesign, and dataset characteristics. The performance numbers above are\nestimates, and assume [best practices](https://cloud.google.com/spanner/docs/bulk-loading)\nare followed.",
- "type": "integer"
- },
- "labels": {
- "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",
- "additionalProperties": {
- "type": "string"
- }
- },
- "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"
- },
"RollbackRequest": {
- "description": "The request for Rollback.",
- "type": "object",
"properties": {
"transactionId": {
"format": "byte",
@@ -1441,57 +1473,16 @@
"type": "string"
}
},
- "id": "RollbackRequest"
- },
- "Transaction": {
- "description": "A transaction.",
- "type": "object",
- "properties": {
- "id": {
- "format": "byte",
- "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.",
- "type": "string"
- },
- "readTimestamp": {
- "format": "google-datetime",
- "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.",
- "type": "string"
- }
- },
- "id": "Transaction"
- },
- "UpdateDatabaseDdlMetadata": {
- "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
- "type": "object",
- "properties": {
- "statements": {
- "description": "For an update this list contains all the statements. For an\nindividual statement, this list contains only that statement.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "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]`.",
- "items": {
- "format": "google-datetime",
- "type": "string"
- },
- "type": "array"
- },
- "database": {
- "description": "The database being modified.",
- "type": "string"
- }
- },
- "id": "UpdateDatabaseDdlMetadata"
+ "id": "RollbackRequest",
+ "description": "The request for Rollback.",
+ "type": "object"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Spanner",
"auth": {
"oauth2": {
@@ -1519,21 +1510,118 @@
"resources": {
"instances": {
"methods": {
- "get": {
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "id": "spanner.projects.instances.get",
- "path": "v1/{+name}",
- "description": "Gets information about a particular instance.",
+ "delete": {
"response": {
- "$ref": "Instance"
+ "$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
"parameters": {
"name": {
- "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "id": "spanner.projects.instances.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * name\n * display_name\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * name:* --\u003e The instance has a name.\n * name:Howl --\u003e The instance's name contains the string \"howl\".\n * name:HOWL --\u003e Equivalent to above.\n * NAME:howl --\u003e Equivalent to above.\n * labels.env:* --\u003e The instance has the label \"env\".\n * labels.env:dev --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * name:howl labels.env:dev --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances",
+ "id": "spanner.projects.instances.list",
+ "path": "v1/{+parent}/instances",
+ "description": "Lists all instances in the given project."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/\u003cproject\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances",
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.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"
+ }
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/instances/[^/]+$",
@@ -1543,16 +1631,41 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy",
+ "id": "spanner.projects.instances.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy"
+ },
+ "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.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy"
},
"patch": {
- "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.",
"httpMethod": "PATCH",
"parameterOrder": [
"name"
@@ -1572,53 +1685,30 @@
"pattern": "^projects/[^/]+/instances/[^/]+$",
"location": "path"
}
- }
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
},
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "spanner.projects.instances.testIamPermissions",
- "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.patch",
"request": {
- "$ref": "TestIamPermissionsRequest"
- }
+ "$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."
},
- "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.",
+ "get": {
+ "httpMethod": "GET",
"response": {
- "$ref": "Empty"
+ "$ref": "Instance"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
"location": "path",
- "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`",
+ "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+$"
+ "required": true
}
},
"scopes": [
@@ -1626,271 +1716,160 @@
"https://www.googleapis.com/auth/spanner.admin"
],
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "id": "spanner.projects.instances.delete",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.get",
+ "description": "Gets information about a particular instance."
},
- "list": {
- "description": "Lists all instances in the given project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListInstancesResponse"
+ "testIamPermissions": {
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "spanner.projects.instances.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "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 * display_name\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * name:* --\u003e The instance has a name.\n * name:Howl --\u003e The instance's name contains the string \"howl\".\n * name:HOWL --\u003e Equivalent to above.\n * NAME:howl --\u003e Equivalent to above.\n * labels.env:* --\u003e The instance has the label \"env\".\n * labels.env:dev --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * name:howl labels.env:dev --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances",
- "path": "v1/{+parent}/instances",
- "id": "spanner.projects.instances.list"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
+ "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "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.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy",
- "id": "spanner.projects.instances.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "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.",
"response": {
- "$ref": "Operation"
+ "$ref": "TestIamPermissionsResponse"
},
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/\u003cproject\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances",
- "id": "spanner.projects.instances.create",
- "path": "v1/{+parent}/instances"
- },
- "getIamPolicy": {
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
"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.",
+ "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.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+$"
+ "required": true
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy",
- "id": "spanner.projects.instances.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions"
}
},
"resources": {
- "operations": {
+ "databases": {
"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"
- ],
+ "getIamPolicy": {
"httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel",
- "id": "spanner.projects.instances.operations.cancel",
- "path": "v1/{+name}:cancel"
- },
- "delete": {
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
- "name"
+ "resource"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
+ "response": {
+ "$ref": "Policy"
+ },
"parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
+ "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.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
- "id": "spanner.projects.instances.operations.delete",
- "path": "v1/{+name}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "spanner.projects.instances.databases.getIamPolicy",
+ "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
},
"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.",
+ "description": "Gets the state of a Cloud Spanner database.",
"httpMethod": "GET",
+ "response": {
+ "$ref": "Database"
+ },
"parameterOrder": [
"name"
],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the requested database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.get"
+ },
+ "dropDatabase": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "database": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "Required. The database to be dropped.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "id": "spanner.projects.instances.databases.dropDatabase",
+ "path": "v1/{+database}",
+ "description": "Drops (aka deletes) a Cloud Spanner database."
+ },
+ "updateDdl": {
+ "id": "spanner.projects.instances.databases.updateDdl",
+ "path": "v1/{+database}/ddl",
+ "request": {
+ "$ref": "UpdateDatabaseDdlRequest"
+ },
+ "description": "Updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and can be used to\ntrack execution of the schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.",
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.operations.get"
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations",
- "id": "spanner.projects.instances.operations.list",
- "path": "v1/{+name}",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
"parameterOrder": [
- "name"
+ "database"
],
- "httpMethod": "GET",
+ "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
"parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
+ "database": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
"location": "path",
- "description": "The name of the operation's parent resource.",
+ "description": "Required. The database to update.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/operations$"
+ "required": true
}
- }
- }
- }
- },
- "databases": {
- "methods": {
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl"
+ },
"testIamPermissions": {
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "spanner.projects.instances.databases.testIamPermissions",
+ "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",
"request": {
"$ref": "TestIamPermissionsRequest"
},
- "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -1898,10 +1877,6 @@
"response": {
"$ref": "TestIamPermissionsResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
"parameters": {
"resource": {
"description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
@@ -1911,12 +1886,13 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "spanner.projects.instances.databases.testIamPermissions"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions"
},
"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",
"parameterOrder": [
"database"
@@ -1930,18 +1906,21 @@
],
"parameters": {
"database": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
"description": "Required. The database whose schema we wish to get.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
+ "required": true
}
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
"path": "v1/{+database}/ddl",
- "id": "spanner.projects.instances.databases.getDdl"
+ "id": "spanner.projects.instances.databases.getDdl",
+ "description": "Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API."
},
"list": {
+ "id": "spanner.projects.instances.databases.list",
+ "path": "v1/{+parent}/databases",
"description": "Lists Cloud Spanner databases.",
"response": {
"$ref": "ListDatabasesResponse"
@@ -1950,42 +1929,39 @@
"parent"
],
"httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path",
+ "description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "type": "string",
+ "required": true
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
- "parameters": {
- "pageToken": {
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
- "id": "spanner.projects.instances.databases.list",
- "path": "v1/{+parent}/databases"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases"
},
"create": {
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
"id": "spanner.projects.instances.databases.create",
"path": "v1/{+parent}/databases",
- "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.",
"request": {
"$ref": "CreateDatabaseRequest"
},
+ "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.",
"response": {
"$ref": "Operation"
},
@@ -1993,39 +1969,35 @@
"parent"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
"parameters": {
"parent": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
"location": "path",
"description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+$"
+ "required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ]
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases"
},
"setIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
"id": "spanner.projects.instances.databases.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource.",
"request": {
"$ref": "SetIamPolicyRequest"
},
- "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "Policy"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
+ "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.",
@@ -2034,243 +2006,24 @@
"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
"location": "path"
}
- }
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
- }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy",
- "id": "spanner.projects.instances.databases.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- },
- "get": {
- "description": "Gets the state of a Cloud Spanner database.",
- "response": {
- "$ref": "Database"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The name of the requested database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
- "id": "spanner.projects.instances.databases.get",
- "path": "v1/{+name}"
- },
- "dropDatabase": {
- "description": "Drops (aka deletes) a Cloud Spanner database.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "database": {
- "description": "Required. The database to be dropped.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
- "id": "spanner.projects.instances.databases.dropDatabase",
- "path": "v1/{+database}"
- },
- "updateDdl": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "database": {
- "description": "Required. The database to update.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
- "id": "spanner.projects.instances.databases.updateDdl",
- "path": "v1/{+database}/ddl",
- "description": "Updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and can be used to\ntrack execution of the schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.",
- "request": {
- "$ref": "UpdateDatabaseDdlRequest"
- }
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy"
}
},
"resources": {
"sessions": {
"methods": {
- "commit": {
- "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session.",
+ "read": {
+ "id": "spanner.projects.instances.databases.sessions.read",
+ "path": "v1/{+session}:read",
"request": {
- "$ref": "CommitRequest"
+ "$ref": "ReadRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "CommitResponse"
- },
- "parameters": {
- "session": {
- "location": "path",
- "description": "Required. The session in which the transaction to be committed is running.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
- "path": "v1/{+session}:commit",
- "id": "spanner.projects.instances.databases.sessions.commit"
- },
- "beginTransaction": {
- "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.",
- "request": {
- "$ref": "BeginTransactionRequest"
- },
- "response": {
- "$ref": "Transaction"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "parameters": {
- "session": {
- "location": "path",
- "description": "Required. The session in which the transaction runs.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction",
- "id": "spanner.projects.instances.databases.sessions.beginTransaction",
- "path": "v1/{+session}:beginTransaction"
- },
- "delete": {
- "description": "Ends a session, releasing server resources associated with it.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The name of the session to delete.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
- "id": "spanner.projects.instances.databases.sessions.delete",
- "path": "v1/{+name}"
- },
- "executeStreamingSql": {
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql",
- "id": "spanner.projects.instances.databases.sessions.executeStreamingSql",
- "path": "v1/{+session}:executeStreamingSql",
- "request": {
- "$ref": "ExecuteSqlRequest"
- },
- "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB.",
- "response": {
- "$ref": "PartialResultSet"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "session": {
- "location": "path",
- "description": "Required. The session in which the SQL query should be performed.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
- }
- }
- },
- "executeSql": {
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql",
- "id": "spanner.projects.instances.databases.sessions.executeSql",
- "path": "v1/{+session}:executeSql",
- "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",
- "request": {
- "$ref": "ExecuteSqlRequest"
- },
+ "description": "Reads rows from the database using key lookups and scans, as a\nsimple key/value style alternative to\nExecuteSql. This method cannot be used to\nreturn a result set larger than 10 MiB; if the read matches more\ndata than that, the read fails with a `FAILED_PRECONDITION`\nerror.\n\nReads inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be yielded in streaming fashion by calling\nStreamingRead instead.",
"response": {
"$ref": "ResultSet"
},
@@ -2278,6 +2031,63 @@
"session"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the read should be performed.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read"
+ },
+ "get": {
+ "response": {
+ "$ref": "Session"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the session to retrieve.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
+ "id": "spanner.projects.instances.databases.sessions.get",
+ "path": "v1/{+name}",
+ "description": "Gets a session. Returns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determining whether a session is still\nalive."
+ },
+ "executeStreamingSql": {
+ "request": {
+ "$ref": "ExecuteSqlRequest"
+ },
+ "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "PartialResultSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
"parameters": {
"session": {
"description": "Required. The session in which the SQL query should be performed.",
@@ -2287,59 +2097,171 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ]
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql",
+ "path": "v1/{+session}:executeStreamingSql",
+ "id": "spanner.projects.instances.databases.sessions.executeStreamingSql"
},
- "rollback": {
- "request": {
- "$ref": "RollbackRequest"
+ "commit": {
+ "response": {
+ "$ref": "CommitResponse"
},
- "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`.",
- "httpMethod": "POST",
"parameterOrder": [
"session"
],
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.data"
],
"parameters": {
"session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session in which the transaction to be committed is running.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
+ "id": "spanner.projects.instances.databases.sessions.commit",
+ "path": "v1/{+session}:commit",
+ "request": {
+ "$ref": "CommitRequest"
+ },
+ "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session."
+ },
+ "beginTransaction": {
+ "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "Transaction"
+ },
+ "parameters": {
+ "session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session in which the transaction runs.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction",
+ "path": "v1/{+session}:beginTransaction",
+ "id": "spanner.projects.instances.databases.sessions.beginTransaction"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the session to delete.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
+ "id": "spanner.projects.instances.databases.sessions.delete",
+ "path": "v1/{+name}",
+ "description": "Ends a session, releasing server resources associated with it."
+ },
+ "executeSql": {
+ "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",
+ "request": {
+ "$ref": "ExecuteSqlRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "ResultSet"
+ },
+ "parameters": {
+ "session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session in which the SQL query should be performed.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql",
+ "path": "v1/{+session}:executeSql",
+ "id": "spanner.projects.instances.databases.sessions.executeSql"
+ },
+ "rollback": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
"location": "path",
"description": "Required. The session in which the transaction to roll back is running.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
+ "required": true
}
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback",
+ "id": "spanner.projects.instances.databases.sessions.rollback",
"path": "v1/{+session}:rollback",
- "id": "spanner.projects.instances.databases.sessions.rollback"
+ "request": {
+ "$ref": "RollbackRequest"
+ },
+ "description": "Rolls back a transaction, releasing any locks it holds. It is a good\nidea to call this for any transaction that includes one or more\nRead or ExecuteSql requests and\nultimately decides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the transaction, the\ntransaction was already aborted, or the transaction is not\nfound. `Rollback` never returns `ABORTED`."
},
"streamingRead": {
"description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB.",
"request": {
"$ref": "ReadRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
"response": {
"$ref": "PartialResultSet"
},
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
"parameters": {
"session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
"location": "path",
"description": "Required. The session in which the read should be performed.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
+ "required": true
}
},
"scopes": [
@@ -2347,11 +2269,10 @@
"https://www.googleapis.com/auth/spanner.data"
],
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead",
- "path": "v1/{+session}:streamingRead",
- "id": "spanner.projects.instances.databases.sessions.streamingRead"
+ "id": "spanner.projects.instances.databases.sessions.streamingRead",
+ "path": "v1/{+session}:streamingRead"
},
"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\"`.",
"httpMethod": "POST",
"parameterOrder": [
"database"
@@ -2365,71 +2286,17 @@
],
"parameters": {
"database": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
"location": "path",
"description": "Required. The database in which the new session is created.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
+ "required": true
}
},
"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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "ResultSet"
- },
- "parameters": {
- "session": {
- "description": "Required. The session in which the read should be performed.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read",
- "path": "v1/{+session}:read",
- "id": "spanner.projects.instances.databases.sessions.read"
- },
- "get": {
- "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",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Session"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the session to retrieve.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.sessions.get"
+ "id": "spanner.projects.instances.databases.sessions.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\"`."
}
}
},
@@ -2437,17 +2304,13 @@
"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"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
@@ -2457,18 +2320,29 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel",
- "id": "spanner.projects.instances.databases.operations.cancel",
- "path": "v1/{+name}:cancel"
+ "path": "v1/{+name}:cancel",
+ "id": "spanner.projects.instances.databases.operations.cancel"
},
"delete": {
- "response": {
- "$ref": "Empty"
- },
+ "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`.",
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
@@ -2478,17 +2352,9 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/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`."
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}"
},
"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"
},
@@ -2502,22 +2368,19 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
"location": "path",
"description": "The name of the operation resource.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$"
+ "required": true
}
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
"id": "spanner.projects.instances.databases.operations.get",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
},
"list": {
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations",
- "id": "spanner.projects.instances.databases.operations.list",
- "path": "v1/{+name}",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding 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"
},
@@ -2525,22 +2388,7 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
"parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"pageToken": {
"location": "query",
"description": "The standard list page token.",
@@ -2552,56 +2400,197 @@
"required": true,
"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$",
"location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations",
+ "id": "spanner.projects.instances.databases.operations.list",
+ "path": "v1/{+name}",
+ "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."
}
}
}
}
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel",
+ "id": "spanner.projects.instances.operations.cancel",
+ "path": "v1/{+name}:cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
+ "id": "spanner.projects.instances.operations.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "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."
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations",
+ "id": "spanner.projects.instances.operations.list",
+ "path": "v1/{+name}"
+ }
+ }
}
}
},
"instanceConfigs": {
"methods": {
"get": {
- "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}",
- "id": "spanner.projects.instanceConfigs.get",
- "path": "v1/{+name}",
- "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",
"https://www.googleapis.com/auth/spanner.admin"
],
"parameters": {
"name": {
- "location": "path",
"description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/\u003cproject\u003e/instanceConfigs/\u003cconfig\u003e`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$"
+ "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$",
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instanceConfigs.get",
+ "description": "Gets information about a particular instance configuration."
},
"list": {
+ "path": "v1/{+parent}/instanceConfigs",
+ "id": "spanner.projects.instanceConfigs.list",
"description": "Lists the supported instance configurations for a given project.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListInstanceConfigsResponse"
},
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
"parameters": {
"pageToken": {
"description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
@@ -2609,22 +2598,24 @@
"location": "query"
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"parent": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/\u003cproject\u003e`.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
+ "required": true
}
},
- "flatPath": "v1/projects/{projectsId}/instanceConfigs",
- "id": "spanner.projects.instanceConfigs.list",
- "path": "v1/{+parent}/instanceConfigs"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instanceConfigs"
}
}
}
@@ -2632,30 +2623,22 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -2664,12 +2647,9 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
"enumDescriptions": [
@@ -2687,20 +2667,20 @@
],
"type": "string"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -2714,11 +2694,31 @@
"type": "string"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
}
},
"version": "v1",
- "baseUrl": "https://spanner.googleapis.com/"
+ "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": "",
+ "revision": "20170726",
+ "documentationLink": "https://cloud.google.com/spanner/",
+ "id": "spanner:v1",
+ "discoveryVersion": "v1",
+ "version_module": "True"
}
diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json
index df46ff4..0dba38c 100644
--- a/speech/v1/speech-api.json
+++ b/speech/v1/speech-api.json
@@ -1,269 +1,169 @@
{
- "title": "Google Cloud Speech API",
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/operations/{+name}:cancel",
- "id": "speech.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`.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/operations/{+name}",
- "id": "speech.operations.delete"
- },
- "get": {
- "id": "speech.operations.get",
- "path": "v1/operations/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/operations/{operationsId}"
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "location": "query",
- "description": "The name of the operation's parent resource.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/operations",
- "id": "speech.operations.list",
- "path": "v1/operations",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- }
- }
- },
- "speech": {
- "methods": {
- "longrunningrecognize": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/speech:longrunningrecognize",
- "path": "v1/speech:longrunningrecognize",
- "id": "speech.speech.longrunningrecognize",
- "description": "Performs asynchronous speech recognition: receive results via the\ngoogle.longrunning.Operations interface. Returns either an\n`Operation.error` or an `Operation.response` which contains\na `LongRunningRecognizeResponse` message.",
- "request": {
- "$ref": "LongRunningRecognizeRequest"
- }
- },
- "recognize": {
- "response": {
- "$ref": "RecognizeResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/speech:recognize",
- "id": "speech.speech.recognize",
- "path": "v1/speech:recognize",
- "request": {
- "$ref": "RecognizeRequest"
- },
- "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed."
- }
- }
- }
- },
- "parameters": {
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.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"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- }
- },
- "version": "v1",
- "baseUrl": "https://speech.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Converts audio to text by applying powerful neural network models.",
- "basePath": "",
- "id": "speech:v1",
- "documentationLink": "https://cloud.google.com/speech/",
- "revision": "20170822",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Operation": {
+ "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"
+ },
+ "RecognizeRequest": {
+ "id": "RecognizeRequest",
+ "description": "The top-level message sent by the client for the `Recognize` method.",
+ "type": "object",
"properties": {
+ "audio": {
+ "description": "*Required* The audio data to be recognized.",
+ "$ref": "RecognitionAudio"
+ },
+ "config": {
+ "$ref": "RecognitionConfig",
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
+ }
+ }
+ },
+ "SpeechRecognitionAlternative": {
+ "id": "SpeechRecognitionAlternative",
+ "description": "Alternative hypotheses (a.k.a. n-best list).",
+ "type": "object",
+ "properties": {
+ "words": {
+ "description": "*Output-only* A list of word-specific information for each recognized word.",
+ "items": {
+ "$ref": "WordInfo"
+ },
+ "type": "array"
+ },
+ "transcript": {
+ "description": "*Output-only* Transcript text representing the words that the user spoke.",
+ "type": "string"
+ },
+ "confidence": {
+ "format": "float",
+ "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate or consistent.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
+ "type": "number"
+ }
+ }
+ },
+ "ListOperationsResponse": {
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "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).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "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 top (first)\nalternative being the most probable, as ranked by the recognizer.",
+ "items": {
+ "$ref": "SpeechRecognitionAlternative"
+ },
+ "type": "array"
+ }
+ },
+ "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": {
+ "format": "byte",
+ "description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
+ "type": "string"
+ },
+ "uri": {
+ "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
+ "type": "string"
+ }
+ },
+ "id": "RecognitionAudio"
+ },
+ "LongRunningRecognizeRequest": {
+ "description": "The top-level message sent by the client for the `LongRunningRecognize`\nmethod.",
+ "type": "object",
+ "properties": {
+ "audio": {
+ "description": "*Required* The audio data to be recognized.",
+ "$ref": "RecognitionAudio"
+ },
+ "config": {
+ "$ref": "RecognitionConfig",
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
+ }
+ },
+ "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.",
+ "items": {
+ "$ref": "SpeechRecognitionResult"
+ },
+ "type": "array"
+ }
+ },
+ "id": "RecognizeResponse"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "Operation": {
+ "id": "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": {
+ "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"
@@ -275,30 +175,19 @@
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
}
- },
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ }
},
"RecognitionConfig": {
+ "id": "RecognitionConfig",
+ "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
+ "type": "object",
"properties": {
+ "sampleRateHertz": {
+ "format": "int32",
+ "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).",
+ "type": "integer"
+ },
"enableWordTimeOffsets": {
"description": "*Optional* If `true`, the top result includes a list of words and\nthe start and end time offsets (timestamps) for those words. If\n`false`, no word-level time offset information is returned. The default is\n`false`.",
"type": "boolean"
@@ -319,7 +208,21 @@
},
"type": "array"
},
+ "profanityFilter": {
+ "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
+ "type": "boolean"
+ },
"encoding": {
+ "enumDescriptions": [
+ "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.",
+ "Uncompressed 16-bit signed little-endian samples (Linear PCM).",
+ "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio\nCodec) is the recommended encoding because it is\nlossless--therefore recognition is not compromised--and\nrequires only about half the bandwidth of `LINEAR16`. `FLAC` stream\nencoding supports 16-bit and 24-bit samples, however, not all fields in\n`STREAMINFO` are supported.",
+ "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
+ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.",
+ "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.",
+ "Opus encoded audio frames in Ogg container\n([OggOpus](https://wiki.xiph.org/OggOpus)).\n`sample_rate_hertz` must be 16000.",
+ "Although the use of lossy encodings is not recommended, if a very low\nbitrate encoding is required, `OGG_OPUS` is highly preferred over\nSpeex encoding. The [Speex](https://speex.org/) encoding supported by\nCloud Speech API has a header byte in each block, as in MIME type\n`audio/x-speex-with-header-byte`.\nIt is a variant of the RTP Speex encoding defined in\n[RFC 5574](https://tools.ietf.org/html/rfc5574).\nThe stream is a sequence of blocks, one block per RTP packet. Each block\nstarts with a byte containing the length of the block, in bytes, followed\nby one or more frames of Speex data, padded to an integral number of\nbytes (octets) as specified in RFC 5574. In other words, each RTP header\nis replaced with a single byte containing the block length. Only Speex\nwideband is supported. `sample_rate_hertz` must be 16000."
+ ],
"enum": [
"ENCODING_UNSPECIFIED",
"LINEAR16",
@@ -331,31 +234,9 @@
"SPEEX_WITH_HEADER_BYTE"
],
"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).",
- "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio\nCodec) is the recommended encoding because it is\nlossless--therefore recognition is not compromised--and\nrequires only about half the bandwidth of `LINEAR16`. `FLAC` stream\nencoding supports 16-bit and 24-bit samples, however, not all fields in\n`STREAMINFO` are supported.",
- "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
- "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.",
- "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.",
- "Opus encoded audio frames in Ogg container\n([OggOpus](https://wiki.xiph.org/OggOpus)).\n`sample_rate_hertz` must be 16000.",
- "Although the use of lossy encodings is not recommended, if a very low\nbitrate encoding is required, `OGG_OPUS` is highly preferred over\nSpeex encoding. The [Speex](https://speex.org/) encoding supported by\nCloud Speech API has a header byte in each block, as in MIME type\n`audio/x-speex-with-header-byte`.\nIt is a variant of the RTP Speex encoding defined in\n[RFC 5574](https://tools.ietf.org/html/rfc5574).\nThe stream is a sequence of blocks, one block per RTP packet. Each block\nstarts with a byte containing the length of the block, in bytes, followed\nby one or more frames of Speex data, padded to an integral number of\nbytes (octets) as specified in RFC 5574. In other words, each RTP header\nis replaced with a single byte containing the block length. Only Speex\nwideband is supported. `sample_rate_hertz` must be 16000."
- ]
- },
- "profanityFilter": {
- "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
- "type": "boolean"
- },
- "sampleRateHertz": {
- "format": "int32",
- "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).",
- "type": "integer"
+ "type": "string"
}
- },
- "id": "RecognitionConfig",
- "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
- "type": "object"
+ }
},
"WordInfo": {
"description": "Word-specific information for recognized words. Word information is only\nincluded in the response when certain request parameters are set, such\nas `enable_word_time_offsets`.",
@@ -379,6 +260,8 @@
"id": "WordInfo"
},
"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.",
@@ -401,150 +284,7 @@
"type": "integer"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "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"
- },
- "RecognizeRequest": {
- "properties": {
- "audio": {
- "description": "*Required* The audio data to be recognized.",
- "$ref": "RecognitionAudio"
- },
- "config": {
- "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
- "$ref": "RecognitionConfig"
- }
- },
- "id": "RecognizeRequest",
- "description": "The top-level message sent by the client for the `Recognize` method.",
- "type": "object"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
- }
- },
- "id": "ListOperationsResponse"
- },
- "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).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "SpeechContext"
- },
- "SpeechRecognitionAlternative": {
- "description": "Alternative hypotheses (a.k.a. n-best list).",
- "type": "object",
- "properties": {
- "confidence": {
- "format": "float",
- "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate or consistent.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
- "type": "number"
- },
- "words": {
- "description": "*Output-only* A list of word-specific information for each recognized word.",
- "items": {
- "$ref": "WordInfo"
- },
- "type": "array"
- },
- "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 top (first)\nalternative being the most probable, as ranked by the recognizer.",
- "items": {
- "$ref": "SpeechRecognitionAlternative"
- },
- "type": "array"
- }
- },
- "id": "SpeechRecognitionResult",
- "description": "A speech recognition result corresponding to a portion of the audio.",
- "type": "object"
- },
- "RecognitionAudio": {
- "properties": {
- "content": {
- "format": "byte",
- "description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
- "type": "string"
- },
- "uri": {
- "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
- "type": "string"
- }
- },
- "id": "RecognitionAudio",
- "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
- "type": "object"
- },
- "LongRunningRecognizeRequest": {
- "properties": {
- "audio": {
- "$ref": "RecognitionAudio",
- "description": "*Required* The audio data to be recognized."
- },
- "config": {
- "$ref": "RecognitionConfig",
- "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
- }
- },
- "id": "LongRunningRecognizeRequest",
- "description": "The top-level message sent by the client for the `LongRunningRecognize`\nmethod.",
- "type": "object"
- },
- "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.",
- "items": {
- "$ref": "SpeechRecognitionResult"
- },
- "type": "array"
- }
- },
- "id": "RecognizeResponse"
- },
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
+ "id": "Status"
}
},
"icons": {
@@ -565,5 +305,265 @@
"rootUrl": "https://speech.googleapis.com/",
"ownerDomain": "google.com",
"name": "speech",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "title": "Google Cloud Speech API",
+ "ownerName": "Google",
+ "resources": {
+ "operations": {
+ "methods": {
+ "delete": {
+ "path": "v1/operations/{+name}",
+ "id": "speech.operations.delete",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations/{operationsId}"
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/operations/{+name}",
+ "id": "speech.operations.get"
+ },
+ "list": {
+ "path": "v1/operations",
+ "id": "speech.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name of the operation's parent resource.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/operations"
+ },
+ "cancel": {
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "id": "speech.operations.cancel",
+ "path": "v1/operations/{+name}:cancel"
+ }
+ }
+ },
+ "speech": {
+ "methods": {
+ "longrunningrecognize": {
+ "id": "speech.speech.longrunningrecognize",
+ "path": "v1/speech:longrunningrecognize",
+ "request": {
+ "$ref": "LongRunningRecognizeRequest"
+ },
+ "description": "Performs asynchronous speech recognition: receive results via the\ngoogle.longrunning.Operations interface. Returns either an\n`Operation.error` or an `Operation.response` which contains\na `LongRunningRecognizeResponse` message.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/speech:longrunningrecognize"
+ },
+ "recognize": {
+ "request": {
+ "$ref": "RecognizeRequest"
+ },
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "RecognizeResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/speech:recognize",
+ "path": "v1/speech:recognize",
+ "id": "speech.speech.recognize"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://speech.googleapis.com/",
+ "servicePath": "",
+ "description": "Converts audio to text by applying powerful neural network models.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "documentationLink": "https://cloud.google.com/speech/",
+ "revision": "20170822",
+ "id": "speech:v1"
}
diff --git a/speech/v1beta1/speech-api.json b/speech/v1beta1/speech-api.json
index e3dbbcb..7e1e6c3 100644
--- a/speech/v1beta1/speech-api.json
+++ b/speech/v1beta1/speech-api.json
@@ -1,301 +1,24 @@
{
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1beta1/operations/{operationsId}",
- "path": "v1beta1/operations/{+name}",
- "id": "speech.operations.get"
- },
- "list": {
- "flatPath": "v1beta1/operations",
- "id": "speech.operations.list",
- "path": "v1beta1/operations",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "location": "query",
- "description": "The name of the operation's parent resource."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "The standard list page size."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "cancel": {
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/operations/{operationsId}:cancel",
- "id": "speech.operations.cancel",
- "path": "v1beta1/operations/{+name}: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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1beta1/operations/{operationsId}",
- "path": "v1beta1/operations/{+name}",
- "id": "speech.operations.delete"
- }
- }
- },
- "speech": {
- "methods": {
- "asyncrecognize": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/speech:asyncrecognize",
- "id": "speech.speech.asyncrecognize",
- "path": "v1beta1/speech:asyncrecognize",
- "request": {
- "$ref": "AsyncRecognizeRequest"
- },
- "description": "Performs asynchronous speech recognition: receive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` or an `Operation.response` which contains\nan `AsyncRecognizeResponse` message."
- },
- "syncrecognize": {
- "response": {
- "$ref": "SyncRecognizeResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "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": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "alt": {
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ]
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- }
- },
"version": "v1beta1",
"baseUrl": "https://speech.googleapis.com/",
- "servicePath": "",
- "description": "Converts audio to text by applying powerful neural network models.",
"kind": "discovery#restDescription",
+ "description": "Converts audio to text by applying powerful neural network models.",
+ "servicePath": "",
"basePath": "",
- "documentationLink": "https://cloud.google.com/speech/",
- "revision": "20170822",
"id": "speech:v1beta1",
+ "revision": "20170822",
+ "documentationLink": "https://cloud.google.com/speech/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "RecognitionAudio": {
- "type": "object",
- "properties": {
- "content": {
- "format": "byte",
- "description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
- "type": "string"
- },
- "uri": {
- "type": "string",
- "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris)."
- }
- },
- "id": "RecognitionAudio",
- "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)."
- },
- "AsyncRecognizeRequest": {
- "description": "The top-level message sent by the client for the `AsyncRecognize` method.",
- "type": "object",
- "properties": {
- "audio": {
- "$ref": "RecognitionAudio",
- "description": "*Required* The audio data to be recognized."
- },
- "config": {
- "$ref": "RecognitionConfig",
- "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
- }
- },
- "id": "AsyncRecognizeRequest"
- },
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
"response": {
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
+ "description": "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"
@@ -310,23 +33,46 @@
},
"metadata": {
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
"description": "Service-specific metadata associated with the operation. 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."
+ "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"
},
"RecognitionConfig": {
+ "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
"type": "object",
"properties": {
+ "maxAlternatives": {
+ "format": "int32",
+ "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.",
+ "type": "integer"
+ },
+ "sampleRate": {
+ "format": "int32",
+ "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).",
+ "type": "integer"
+ },
+ "languageCode": {
+ "description": "*Optional* The language of the supplied audio as a BCP-47 language tag.\nExample: \"en-GB\" https://www.rfc-editor.org/rfc/bcp/bcp47.txt\nIf omitted, defaults to \"en-US\". See\n[Language Support](https://cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes.",
+ "type": "string"
+ },
"encoding": {
+ "enumDescriptions": [
+ "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.",
+ "Uncompressed 16-bit signed little-endian samples (Linear PCM).\nThis is the only encoding that may be used by `AsyncRecognize`.",
+ "This is the recommended encoding for `SyncRecognize` and\n`StreamingRecognize` because it uses lossless compression; therefore\nrecognition accuracy is not compromised by a lossy codec.\n\nThe stream FLAC (Free Lossless Audio Codec) encoding is specified at:\nhttp://flac.sourceforge.net/documentation.html.\n16-bit and 24-bit samples are supported.\nNot all fields in STREAMINFO are supported.",
+ "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
+ "Adaptive Multi-Rate Narrowband codec. `sample_rate` must be 8000 Hz.",
+ "Adaptive Multi-Rate Wideband codec. `sample_rate` must be 16000 Hz."
+ ],
"enum": [
"ENCODING_UNSPECIFIED",
"LINEAR16",
@@ -336,56 +82,47 @@
"AMR_WB"
],
"description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.",
- "Uncompressed 16-bit signed little-endian samples (Linear PCM).\nThis is the only encoding that may be used by `AsyncRecognize`.",
- "This is the recommended encoding for `SyncRecognize` and\n`StreamingRecognize` because it uses lossless compression; therefore\nrecognition accuracy is not compromised by a lossy codec.\n\nThe stream FLAC (Free Lossless Audio Codec) encoding is specified at:\nhttp://flac.sourceforge.net/documentation.html.\n16-bit and 24-bit samples are supported.\nNot all fields in STREAMINFO are supported.",
- "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
- "Adaptive Multi-Rate Narrowband codec. `sample_rate` must be 8000 Hz.",
- "Adaptive Multi-Rate Wideband codec. `sample_rate` must be 16000 Hz."
- ]
+ "type": "string"
},
"profanityFilter": {
"description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
"type": "boolean"
},
"speechContext": {
- "$ref": "SpeechContext",
- "description": "*Optional* A means to provide context to assist the speech recognition."
- },
- "maxAlternatives": {
- "type": "integer",
- "format": "int32",
- "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."
- },
- "sampleRate": {
- "type": "integer",
- "format": "int32",
- "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling)."
- },
- "languageCode": {
- "type": "string",
- "description": "*Optional* The language of the supplied audio as a BCP-47 language tag.\nExample: \"en-GB\" https://www.rfc-editor.org/rfc/bcp/bcp47.txt\nIf omitted, defaults to \"en-US\". See\n[Language Support](https://cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes."
+ "description": "*Optional* A means to provide context to assist the speech recognition.",
+ "$ref": "SpeechContext"
}
},
- "id": "RecognitionConfig",
- "description": "Provides information to the recognizer that specifies how to process the\nrequest."
+ "id": "RecognitionConfig"
},
"SyncRecognizeRequest": {
- "description": "The top-level message sent by the client for the `SyncRecognize` method.",
- "type": "object",
"properties": {
"audio": {
- "$ref": "RecognitionAudio",
- "description": "*Required* The audio data to be recognized."
+ "description": "*Required* The audio data to be recognized.",
+ "$ref": "RecognitionAudio"
},
"config": {
"$ref": "RecognitionConfig",
"description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
}
},
- "id": "SyncRecognizeRequest"
+ "id": "SyncRecognizeRequest",
+ "description": "The top-level message sent by the client for the `SyncRecognize` method.",
+ "type": "object"
+ },
+ "SyncRecognizeResponse": {
+ "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
+ "type": "object",
+ "properties": {
+ "results": {
+ "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
+ "items": {
+ "$ref": "SpeechRecognitionResult"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SyncRecognizeResponse"
},
"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.",
@@ -403,9 +140,9 @@
"type": "array"
},
"code": {
- "type": "integer",
"format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code."
+ "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.",
@@ -414,25 +151,41 @@
},
"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",
+ "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"
+ },
+ "SpeechRecognitionAlternative": {
"properties": {
- "results": {
- "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
+ "confidence": {
+ "format": "float",
+ "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
+ "type": "number"
+ },
+ "transcript": {
+ "description": "*Output-only* Transcript text representing the words that the user spoke.",
+ "type": "string"
+ }
+ },
+ "id": "SpeechRecognitionAlternative",
+ "description": "Alternative hypotheses (a.k.a. n-best list).",
+ "type": "object"
+ },
+ "SpeechContext": {
+ "properties": {
+ "phrases": {
+ "description": "*Optional* A list of strings containing words and phrases \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech/limits#content).",
"items": {
- "$ref": "SpeechRecognitionResult"
+ "type": "string"
},
"type": "array"
}
},
- "id": "SyncRecognizeResponse"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "id": "SpeechContext",
+ "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
+ "type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -452,36 +205,6 @@
},
"id": "ListOperationsResponse"
},
- "SpeechContext": {
- "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
- "type": "object",
- "properties": {
- "phrases": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "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)."
- }
- },
- "id": "SpeechContext"
- },
- "SpeechRecognitionAlternative": {
- "description": "Alternative hypotheses (a.k.a. n-best list).",
- "type": "object",
- "properties": {
- "confidence": {
- "format": "float",
- "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
- "type": "number"
- },
- "transcript": {
- "description": "*Output-only* Transcript text representing the words that the user spoke.",
- "type": "string"
- }
- },
- "id": "SpeechRecognitionAlternative"
- },
"SpeechRecognitionResult": {
"description": "A speech recognition result corresponding to a portion of the audio.",
"type": "object",
@@ -495,6 +218,37 @@
}
},
"id": "SpeechRecognitionResult"
+ },
+ "RecognitionAudio": {
+ "properties": {
+ "content": {
+ "format": "byte",
+ "description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
+ "type": "string"
+ },
+ "uri": {
+ "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
+ "type": "string"
+ }
+ },
+ "id": "RecognitionAudio",
+ "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
+ "type": "object"
+ },
+ "AsyncRecognizeRequest": {
+ "description": "The top-level message sent by the client for the `AsyncRecognize` method.",
+ "type": "object",
+ "properties": {
+ "audio": {
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
+ },
+ "config": {
+ "$ref": "RecognitionConfig",
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
+ }
+ },
+ "id": "AsyncRecognizeRequest"
}
},
"icons": {
@@ -517,5 +271,251 @@
"name": "speech",
"batchPath": "batch",
"title": "Google Cloud Speech API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "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`."
+ },
+ "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.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/operations/{operationsId}",
+ "id": "speech.operations.delete",
+ "path": "v1beta1/operations/{+name}"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/operations/{operationsId}",
+ "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."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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."
+ }
+ }
+ },
+ "speech": {
+ "methods": {
+ "syncrecognize": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SyncRecognizeResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/speech:syncrecognize",
+ "path": "v1beta1/speech:syncrecognize",
+ "id": "speech.speech.syncrecognize",
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
+ "request": {
+ "$ref": "SyncRecognizeRequest"
+ }
+ },
+ "asyncrecognize": {
+ "id": "speech.speech.asyncrecognize",
+ "path": "v1beta1/speech:asyncrecognize",
+ "description": "Performs asynchronous speech recognition: receive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` or an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
+ "request": {
+ "$ref": "AsyncRecognizeRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/speech:asyncrecognize"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "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": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ }
}
diff --git a/storagetransfer/v1/storagetransfer-api.json b/storagetransfer/v1/storagetransfer-api.json
index eec039e..f6331e5 100644
--- a/storagetransfer/v1/storagetransfer-api.json
+++ b/storagetransfer/v1/storagetransfer-api.json
@@ -1,47 +1,20 @@
{
- "protocol": "rest",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "version": "v1",
- "baseUrl": "https://storagetransfer.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
- "servicePath": "",
- "kind": "discovery#restDescription",
"rootUrl": "https://storagetransfer.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "storagetransfer",
"batchPath": "batch",
- "id": "storagetransfer:v1",
- "documentationLink": "https://cloud.google.com/storage/transfer",
"revision": "20170810",
+ "documentationLink": "https://cloud.google.com/storage/transfer",
+ "id": "storagetransfer:v1",
"title": "Google Storage Transfer API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"googleServiceAccounts": {
"methods": {
"get": {
- "description": "Returns the Google service account that is used by Storage Transfer\nService to access buckets in the project where transfers\nrun or in other projects. Each Google service account is associated\nwith one Google Cloud Platform Console project. Users\nshould add this service account to the Google Cloud Storage bucket\nACLs to grant access to Storage Transfer Service. This service\naccount is created and owned by Storage Transfer Service and can\nonly be used by Storage Transfer Service.",
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleServiceAccount"
- },
- "parameterOrder": [
- "projectId"
- ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -54,39 +27,36 @@
}
},
"flatPath": "v1/googleServiceAccounts/{projectId}",
+ "id": "storagetransfer.googleServiceAccounts.get",
"path": "v1/googleServiceAccounts/{projectId}",
- "id": "storagetransfer.googleServiceAccounts.get"
+ "description": "Returns the Google service account that is used by Storage Transfer\nService to access buckets in the project where transfers\nrun or in other projects. Each Google service account is associated\nwith one Google Cloud Platform Console project. Users\nshould add this service account to the Google Cloud Storage bucket\nACLs to grant access to Storage Transfer Service. This service\naccount is created and owned by Storage Transfer Service and can\nonly be used by Storage Transfer Service.",
+ "response": {
+ "$ref": "GoogleServiceAccount"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET"
}
}
},
"transferOperations": {
"methods": {
- "get": {
+ "pause": {
+ "request": {
+ "$ref": "PauseTransferOperationRequest"
+ },
+ "description": "Pauses a transfer operation.",
"response": {
- "$ref": "Operation"
+ "$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^transferOperations/.+$",
- "location": "path"
- }
- },
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/transferOperations/{transferOperationsId}",
- "id": "storagetransfer.transferOperations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "pause": {
"parameters": {
"name": {
"description": "The name of the transfer operation.\nRequired.",
@@ -96,23 +66,9 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/transferOperations/{transferOperationsId}:pause",
- "path": "v1/{+name}:pause",
"id": "storagetransfer.transferOperations.pause",
- "description": "Pauses a transfer operation.",
- "request": {
- "$ref": "PauseTransferOperationRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- }
+ "path": "v1/{+name}:pause"
},
"delete": {
"httpMethod": "DELETE",
@@ -122,6 +78,9 @@
"parameterOrder": [
"name"
],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
@@ -131,9 +90,6 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/transferOperations/{transferOperationsId}",
"path": "v1/{+name}",
"id": "storagetransfer.transferOperations.delete",
@@ -148,34 +104,34 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "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"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The list page token."
- },
- "name": {
- "location": "path",
- "description": "The value `transferOperations`.",
- "type": "string",
- "required": true,
- "pattern": "^transferOperations$"
- },
"pageSize": {
"format": "int32",
"description": "The list page size. The max allowed value is 256.",
"type": "integer",
"location": "query"
+ },
+ "filter": {
+ "description": "A list of query parameters specified as JSON text in the form of {\\\"project_id\\\" : \\\"my_project_id\\\", \\\"job_names\\\" : [\\\"jobid1\\\", \\\"jobid2\\\",...], \\\"operation_names\\\" : [\\\"opid1\\\", \\\"opid2\\\",...], \\\"transfer_statuses\\\":[\\\"status1\\\", \\\"status2\\\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The list page token.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The value `transferOperations`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^transferOperations$",
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/transferOperations",
"id": "storagetransfer.transferOperations.list",
"path": "v1/{+name}"
@@ -194,11 +150,11 @@
"httpMethod": "POST",
"parameters": {
"name": {
+ "pattern": "^transferOperations/.+$",
"location": "path",
"description": "The name of the transfer operation.\nRequired.",
"type": "string",
- "required": true,
- "pattern": "^transferOperations/.+$"
+ "required": true
}
},
"scopes": [
@@ -209,17 +165,13 @@
"path": "v1/{+name}:resume"
},
"cancel": {
- "flatPath": "v1/transferOperations/{transferOperationsId}:cancel",
- "id": "storagetransfer.transferOperations.cancel",
- "path": "v1/{+name}:cancel",
- "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
+ "httpMethod": "POST",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
"parameters": {
"name": {
"location": "path",
@@ -231,34 +183,42 @@
},
"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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^transferOperations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource."
+ }
+ },
+ "flatPath": "v1/transferOperations/{transferOperationsId}",
+ "id": "storagetransfer.transferOperations.get",
+ "path": "v1/{+name}"
}
}
},
"transferJobs": {
"methods": {
"list": {
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The list page size. The max allowed value is 256.",
- "type": "integer"
- },
- "filter": {
- "description": "A list of query parameters specified as JSON text in the form of\n{\"project_id\":\"my_project_id\",\n\"job_names\":[\"jobid1\",\"jobid2\",...],\n\"job_statuses\":[\"status1\",\"status2\",...]}.\nSince `job_names` and `job_statuses` support multiple values, their values\nmust be specified with array notation. `project_id` is required. `job_names`\nand `job_statuses` are optional. The valid values for `job_statuses` are\ncase-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The list page token.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/transferJobs",
"id": "storagetransfer.transferJobs.list",
"path": "v1/transferJobs",
@@ -267,9 +227,37 @@
"$ref": "ListTransferJobsResponse"
},
"parameterOrder": [],
- "httpMethod": "GET"
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "The list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The list page size. The max allowed value is 256.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A list of query parameters specified as JSON text in the form of\n{\"project_id\":\"my_project_id\",\n\"job_names\":[\"jobid1\",\"jobid2\",...],\n\"job_statuses\":[\"status1\",\"status2\",...]}.\nSince `job_names` and `job_statuses` support multiple values, their values\nmust be specified with array notation. `project_id` is required. `job_names`\nand `job_statuses` are optional. The valid values for `job_statuses` are\ncase-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "jobName"
+ ],
+ "response": {
+ "$ref": "TransferJob"
+ },
"parameters": {
"projectId": {
"type": "string",
@@ -277,11 +265,11 @@
"description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired."
},
"jobName": {
+ "location": "path",
"description": "The job to get.\nRequired.",
"type": "string",
"required": true,
- "pattern": "^transferJobs/.+$",
- "location": "path"
+ "pattern": "^transferJobs/.+$"
}
},
"scopes": [
@@ -290,14 +278,7 @@
"flatPath": "v1/transferJobs/{transferJobsId}",
"path": "v1/{+jobName}",
"id": "storagetransfer.transferJobs.get",
- "description": "Gets a transfer job.",
- "httpMethod": "GET",
- "response": {
- "$ref": "TransferJob"
- },
- "parameterOrder": [
- "jobName"
- ]
+ "description": "Gets a transfer job."
},
"patch": {
"id": "storagetransfer.transferJobs.patch",
@@ -315,11 +296,11 @@
"httpMethod": "PATCH",
"parameters": {
"jobName": {
+ "type": "string",
+ "required": true,
"pattern": "^transferJobs/.+$",
"location": "path",
- "description": "The name of job to update.\nRequired.",
- "type": "string",
- "required": true
+ "description": "The name of job to update.\nRequired."
}
},
"scopes": [
@@ -328,13 +309,6 @@
"flatPath": "v1/transferJobs/{transferJobsId}"
},
"create": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.create",
- "path": "v1/transferJobs",
"request": {
"$ref": "TransferJob"
},
@@ -343,42 +317,28 @@
"$ref": "TransferJob"
},
"parameterOrder": [],
- "httpMethod": "POST"
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/transferJobs",
+ "id": "storagetransfer.transferJobs.create",
+ "path": "v1/transferJobs"
}
}
}
},
"parameters": {
- "key": {
- "type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"upload_protocol": {
"location": "query",
@@ -391,36 +351,35 @@
"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"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
+ "type": "string"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -433,253 +392,32 @@
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use 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": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Pretty-print response."
}
},
"schemas": {
- "ErrorSummary": {
- "properties": {
- "errorCode": {
- "type": "string",
- "enumDescriptions": [
- "Not an error; returned on success\n\nHTTP Mapping: 200 OK",
- "The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request",
- "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error",
- "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request",
- "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout",
- "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found",
- "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict",
- "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden",
- "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized",
- "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests",
- "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request",
- "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict",
- "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request",
- "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented",
- "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error",
- "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable",
- "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error"
- ],
- "enum": [
- "OK",
- "CANCELLED",
- "UNKNOWN",
- "INVALID_ARGUMENT",
- "DEADLINE_EXCEEDED",
- "NOT_FOUND",
- "ALREADY_EXISTS",
- "PERMISSION_DENIED",
- "UNAUTHENTICATED",
- "RESOURCE_EXHAUSTED",
- "FAILED_PRECONDITION",
- "ABORTED",
- "OUT_OF_RANGE",
- "UNIMPLEMENTED",
- "INTERNAL",
- "UNAVAILABLE",
- "DATA_LOSS"
- ],
- "description": "Required."
- },
- "errorCount": {
- "format": "int64",
- "description": "Count of this type of error.\nRequired.",
- "type": "string"
- },
- "errorLogEntries": {
- "description": "Error samples.",
- "items": {
- "$ref": "ErrorLogEntry"
- },
- "type": "array"
- }
- },
- "id": "ErrorSummary",
- "description": "A summary of errors by error code, plus a count and sample error log\nentries.",
- "type": "object"
- },
- "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"
- },
- "GcsData": {
- "properties": {
- "bucketName": {
- "type": "string",
- "description": "Google Cloud Storage bucket name (see\n[Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nRequired."
- }
- },
- "id": "GcsData",
- "description": "In a GcsData, an object's name is the Google Cloud Storage object's name and\nits `lastModificationTime` refers to the object's updated time, which changes\nwhen the content or the metadata of the object is updated.",
- "type": "object"
- },
- "ListTransferJobsResponse": {
- "description": "Response from ListTransferJobs.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "The list next page token."
- },
- "transferJobs": {
- "description": "A list of transfer jobs.",
- "items": {
- "$ref": "TransferJob"
- },
- "type": "array"
- }
- },
- "id": "ListTransferJobsResponse"
- },
- "UpdateTransferJobRequest": {
- "description": "Request passed to UpdateTransferJob.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
- "type": "string"
- },
- "updateTransferJobFieldMask": {
- "format": "google-fieldmask",
- "description": "The field mask of the fields in `transferJob` that are to be updated in\nthis request. Fields in `transferJob` that can be updated are:\n`description`, `transferSpec`, and `status`. To update the `transferSpec`\nof the job, a complete transfer specification has to be provided. An\nincomplete specification which misses any required fields will be rejected\nwith the error `INVALID_ARGUMENT`.",
- "type": "string"
- },
- "transferJob": {
- "$ref": "TransferJob",
- "description": "The job to update. `transferJob` is expected to specify only three fields:\n`description`, `transferSpec`, and `status`. An UpdateTransferJobRequest\nthat specifies other fields will be rejected with an error\n`INVALID_ARGUMENT`.\nRequired."
- }
- },
- "id": "UpdateTransferJobRequest"
- },
- "ObjectConditions": {
- "properties": {
- "includePrefixes": {
- "description": "If `includePrefixes` is specified, objects that satisfy the object\nconditions must have names that start with one of the `includePrefixes`\nand that do not start with any of the `excludePrefixes`. If `includePrefixes`\nis not specified, all objects except those that have names starting with\none of the `excludePrefixes` must satisfy the object conditions.\n\nRequirements:\n\n * Each include-prefix and exclude-prefix can contain any sequence of\n Unicode characters, of max length 1024 bytes when UTF8-encoded, and\n must not contain Carriage Return or Line Feed characters. Wildcard\n matching and regular expression matching are not supported.\n\n * Each include-prefix and exclude-prefix must omit the leading slash.\n For example, to include the `requests.gz` object in a transfer from\n `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include\n prefix as `logs/y=2015/requests.gz`.\n\n * None of the include-prefix or the exclude-prefix values can be empty,\n if specified.\n\n * Each include-prefix must include a distinct portion of the object\n namespace, i.e., no include-prefix may be a prefix of another\n include-prefix.\n\n * Each exclude-prefix must exclude a distinct portion of the object\n namespace, i.e., no exclude-prefix may be a prefix of another\n exclude-prefix.\n\n * If `includePrefixes` is specified, then each exclude-prefix must start\n with the value of a path explicitly included by `includePrefixes`.\n\nThe max size of `includePrefixes` is 1000.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "excludePrefixes": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "`excludePrefixes` must follow the requirements described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 1000."
- },
- "minTimeElapsedSinceLastModification": {
- "format": "google-duration",
- "description": "If unspecified, `minTimeElapsedSinceLastModification` takes a zero value\nand `maxTimeElapsedSinceLastModification` takes the maximum possible\nvalue of Duration. Objects that satisfy the object conditions\nmust either have a `lastModificationTime` greater or equal to\n`NOW` - `maxTimeElapsedSinceLastModification` and less than\n`NOW` - `minTimeElapsedSinceLastModification`, or not have a\n`lastModificationTime`.",
- "type": "string"
- },
- "maxTimeElapsedSinceLastModification": {
- "format": "google-duration",
- "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.",
- "type": "string"
- }
- },
- "id": "ObjectConditions",
- "description": "Conditions that determine which objects will be transferred.",
- "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": {
- "type": "boolean",
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable."
- },
- "response": {
- "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`."
- },
- "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."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Represents the transfer operation object.",
- "type": "object"
- }
- }
- },
- "TransferOptions": {
- "id": "TransferOptions",
- "description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
- "type": "object",
- "properties": {
- "overwriteObjectsAlreadyExistingInSink": {
- "description": "Whether overwriting objects that already exist in the sink is allowed.",
- "type": "boolean"
- },
- "deleteObjectsFromSourceAfterTransfer": {
- "type": "boolean",
- "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink. Note that this option and\n`deleteObjectsUniqueInSink` are mutually exclusive."
- },
- "deleteObjectsUniqueInSink": {
- "description": "Whether objects that exist only in the sink should be deleted. Note that\nthis option and `deleteObjectsFromSourceAfterTransfer` are mutually\nexclusive.",
- "type": "boolean"
- }
- }
- },
- "TransferSpec": {
- "description": "Configuration for running a transfer.",
- "type": "object",
- "properties": {
- "transferOptions": {
- "description": "If the option `deleteObjectsUniqueInSink` is `true`, object conditions\nbased on objects' `lastModificationTime` are ignored and do not exclude\nobjects in a data source or a data sink.",
- "$ref": "TransferOptions"
- },
- "awsS3DataSource": {
- "$ref": "AwsS3Data",
- "description": "An AWS S3 data source."
- },
- "httpDataSource": {
- "description": "An HTTP URL data source.",
- "$ref": "HttpData"
- },
- "objectConditions": {
- "$ref": "ObjectConditions",
- "description": "Only objects that satisfy these object conditions are included in the set\nof data source and data sink objects. Object conditions based on\nobjects' `lastModificationTime` do not exclude objects in a data sink."
- },
- "gcsDataSink": {
- "description": "A Google Cloud Storage data sink.",
- "$ref": "GcsData"
- },
- "gcsDataSource": {
- "description": "A Google Cloud Storage data source.",
- "$ref": "GcsData"
- }
- },
- "id": "TransferSpec"
- },
- "ResumeTransferOperationRequest": {
- "id": "ResumeTransferOperationRequest",
- "description": "Request passed to ResumeTransferOperation.",
- "type": "object",
- "properties": {}
- },
"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",
@@ -687,18 +425,18 @@
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
- "type": "object",
"additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "type": "object"
},
"type": "array"
},
"code": {
+ "type": "integer",
"format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
+ "description": "The status code, which should be an enum value of google.rpc.Code."
},
"message": {
"type": "string",
@@ -707,6 +445,12 @@
},
"id": "Status"
},
+ "ResumeTransferOperationRequest": {
+ "description": "Request passed to ResumeTransferOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "ResumeTransferOperationRequest"
+ },
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
@@ -726,15 +470,15 @@
"id": "ListOperationsResponse"
},
"GoogleServiceAccount": {
+ "description": "Google service account",
"type": "object",
"properties": {
"accountEmail": {
- "description": "Required.",
- "type": "string"
+ "type": "string",
+ "description": "Required."
}
},
- "id": "GoogleServiceAccount",
- "description": "Google service account"
+ "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`.",
@@ -764,85 +508,88 @@
"id": "TimeOfDay"
},
"ErrorLogEntry": {
- "description": "An entry describing an error that has occurred.",
"type": "object",
"properties": {
"errorDetails": {
- "description": "A list of messages that carry the error details.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "A list of messages that carry the error details."
},
"url": {
"description": "A URL that refers to the target (a data source, a data sink,\nor an object) with which the error is associated.\nRequired.",
"type": "string"
}
},
- "id": "ErrorLogEntry"
+ "id": "ErrorLogEntry",
+ "description": "An entry describing an error that has occurred."
},
"TransferJob": {
"description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
"type": "object",
"properties": {
- "description": {
- "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
- "type": "string"
- },
- "transferSpec": {
- "$ref": "TransferSpec",
- "description": "Transfer specification.\nRequired."
- },
- "creationTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "This field cannot be changed by user requests."
- },
- "status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DELETED"
- ],
- "description": "Status of the job. This value MUST be specified for\n`CreateTransferJobRequests`.\n\nNOTE: The effect of the new job status takes place during a subsequent job\nrun. For example, if you change the job status from `ENABLED` to\n`DISABLED`, and an operation spawned by the transfer is running, the status\nchange would not affect the current operation.",
- "type": "string",
- "enumDescriptions": [
- "Zero is an illegal value.",
- "New transfers will be performed based on the schedule.",
- "New transfers will not be scheduled.",
- "This is a soft delete state. After a transfer job is set to this\nstate, the job and all the transfer executions are subject to\ngarbage collection."
- ]
- },
"schedule": {
"description": "Schedule specification.\nRequired.",
"$ref": "Schedule"
},
"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."
+ "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror.",
+ "type": "string"
},
"deletionTime": {
"format": "google-datetime",
"description": "This field cannot be changed by user requests.",
"type": "string"
},
+ "lastModificationTime": {
+ "format": "google-datetime",
+ "description": "This field cannot be changed by user requests.",
+ "type": "string"
+ },
"projectId": {
"description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
"type": "string"
},
- "lastModificationTime": {
+ "description": {
+ "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
+ "type": "string"
+ },
+ "transferSpec": {
+ "description": "Transfer specification.\nRequired.",
+ "$ref": "TransferSpec"
+ },
+ "creationTime": {
"format": "google-datetime",
"description": "This field cannot be changed by user requests.",
"type": "string"
+ },
+ "status": {
+ "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."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "ENABLED",
+ "DISABLED",
+ "DELETED"
+ ],
+ "description": "Status of the job. This value MUST be specified for\n`CreateTransferJobRequests`.\n\nNOTE: The effect of the new job status takes place during a subsequent job\nrun. For example, if you change the job status from `ENABLED` to\n`DISABLED`, and an operation spawned by the transfer is running, the status\nchange would not affect the current operation."
}
},
"id": "TransferJob"
},
"Schedule": {
- "description": "Transfers can be scheduled to recur or to run just once.",
"type": "object",
"properties": {
+ "scheduleStartDate": {
+ "$ref": "Date",
+ "description": "The first day the recurring transfer is scheduled to run. If\n`scheduleStartDate` is in the past, the transfer will run for the first\ntime on the following day.\nRequired."
+ },
"scheduleEndDate": {
"$ref": "Date",
"description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce."
@@ -850,15 +597,14 @@
"startTimeOfDay": {
"$ref": "TimeOfDay",
"description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone."
- },
- "scheduleStartDate": {
- "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"
}
},
- "id": "Schedule"
+ "id": "Schedule",
+ "description": "Transfers can be scheduled to recur or to run just once."
},
"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": {
"format": "int32",
@@ -876,12 +622,9 @@
"type": "integer"
}
},
- "id": "Date",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object"
+ "id": "Date"
},
"TransferOperation": {
- "id": "TransferOperation",
"description": "A description of the execution of a transfer.",
"type": "object",
"properties": {
@@ -904,18 +647,14 @@
"type": "string"
},
"transferSpec": {
- "description": "Transfer specification.\nRequired.",
- "$ref": "TransferSpec"
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
+ },
+ "counters": {
+ "$ref": "TransferCounters",
+ "description": "Information about the progress of the transfer operation."
},
"status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "IN_PROGRESS",
- "PAUSED",
- "SUCCESS",
- "FAILED",
- "ABORTED"
- ],
"description": "Status of the transfer operation.",
"type": "string",
"enumDescriptions": [
@@ -925,12 +664,16 @@
"Completed successfully.",
"Terminated due to an unrecoverable failure.",
"Aborted by the user."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "IN_PROGRESS",
+ "PAUSED",
+ "SUCCESS",
+ "FAILED",
+ "ABORTED"
]
},
- "counters": {
- "$ref": "TransferCounters",
- "description": "Information about the progress of the transfer operation."
- },
"errorBreakdowns": {
"description": "Summarizes errors encountered with sample error log entries.",
"items": {
@@ -942,11 +685,10 @@
"description": "A globally unique ID assigned by the system.",
"type": "string"
}
- }
+ },
+ "id": "TransferOperation"
},
"AwsS3Data": {
- "description": "An AwsS3Data can be a data source, but not a data sink.\nIn an AwsS3Data, an object's name is the S3 object's key name.",
- "type": "object",
"properties": {
"bucketName": {
"description": "S3 Bucket name (see\n[Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).\nRequired.",
@@ -957,22 +699,9 @@
"description": "AWS access key used to sign the API requests to the AWS S3 bucket.\nPermissions on the bucket must be granted to the access ID of the\nAWS access key.\nRequired."
}
},
- "id": "AwsS3Data"
- },
- "AwsAccessKey": {
- "description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).",
- "type": "object",
- "properties": {
- "secretAccessKey": {
- "description": "AWS secret access key. This field is not returned in RPC responses.\nRequired.",
- "type": "string"
- },
- "accessKeyId": {
- "description": "AWS access key ID.\nRequired.",
- "type": "string"
- }
- },
- "id": "AwsAccessKey"
+ "id": "AwsS3Data",
+ "description": "An AwsS3Data can be a data source, but not a data sink.\nIn an AwsS3Data, an object's name is the S3 object's key name.",
+ "type": "object"
},
"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 `{}`.",
@@ -980,16 +709,55 @@
"properties": {},
"id": "Empty"
},
- "PauseTransferOperationRequest": {
- "type": "object",
- "properties": {},
- "id": "PauseTransferOperationRequest",
- "description": "Request passed to PauseTransferOperation."
- },
- "TransferCounters": {
- "description": "A collection of counters that report the progress of a transfer operation.",
+ "AwsAccessKey": {
"type": "object",
"properties": {
+ "accessKeyId": {
+ "type": "string",
+ "description": "AWS access key ID.\nRequired."
+ },
+ "secretAccessKey": {
+ "description": "AWS secret access key. This field is not returned in RPC responses.\nRequired.",
+ "type": "string"
+ }
+ },
+ "id": "AwsAccessKey",
+ "description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html))."
+ },
+ "PauseTransferOperationRequest": {
+ "id": "PauseTransferOperationRequest",
+ "description": "Request passed to PauseTransferOperation.",
+ "type": "object",
+ "properties": {}
+ },
+ "TransferCounters": {
+ "type": "object",
+ "properties": {
+ "objectsCopiedToSink": {
+ "format": "int64",
+ "description": "Objects that are copied to the data sink.",
+ "type": "string"
+ },
+ "objectsFromSourceFailed": {
+ "format": "int64",
+ "description": "Objects in the data source that failed during the transfer.",
+ "type": "string"
+ },
+ "bytesFoundOnlyFromSink": {
+ "format": "int64",
+ "description": "Bytes found only in the data sink that are scheduled to be deleted.",
+ "type": "string"
+ },
+ "objectsDeletedFromSource": {
+ "format": "int64",
+ "description": "Objects that are deleted from the data source.",
+ "type": "string"
+ },
+ "bytesCopiedToSink": {
+ "format": "int64",
+ "description": "Bytes that are copied to the data sink.",
+ "type": "string"
+ },
"bytesFoundFromSource": {
"format": "int64",
"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.",
@@ -1036,42 +804,274 @@
"type": "string"
},
"bytesFailedToDeleteFromSink": {
+ "type": "string",
"format": "int64",
- "description": "Bytes that failed to be deleted from the data sink.",
- "type": "string"
+ "description": "Bytes that failed to be deleted from the data sink."
},
"bytesFromSourceFailed": {
"format": "int64",
"description": "Bytes in the data source that failed during the transfer.",
"type": "string"
- },
- "objectsCopiedToSink": {
+ }
+ },
+ "id": "TransferCounters",
+ "description": "A collection of counters that report the progress of a transfer operation."
+ },
+ "ErrorSummary": {
+ "id": "ErrorSummary",
+ "description": "A summary of errors by error code, plus a count and sample error log\nentries.",
+ "type": "object",
+ "properties": {
+ "errorCount": {
"format": "int64",
- "description": "Objects that are copied to the data sink.",
+ "description": "Count of this type of error.\nRequired.",
"type": "string"
},
- "objectsFromSourceFailed": {
- "format": "int64",
- "description": "Objects in the data source that failed during the transfer.",
- "type": "string"
+ "errorLogEntries": {
+ "description": "Error samples.",
+ "items": {
+ "$ref": "ErrorLogEntry"
+ },
+ "type": "array"
},
- "bytesFoundOnlyFromSink": {
- "format": "int64",
- "description": "Bytes found only in the data sink that are scheduled to be deleted.",
- "type": "string"
- },
- "objectsDeletedFromSource": {
- "format": "int64",
- "description": "Objects that are deleted from the data source.",
- "type": "string"
- },
- "bytesCopiedToSink": {
- "format": "int64",
- "description": "Bytes that are copied to the data sink.",
+ "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",
+ "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error",
+ "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request",
+ "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout",
+ "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found",
+ "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict",
+ "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden",
+ "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized",
+ "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests",
+ "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request",
+ "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict",
+ "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request",
+ "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented",
+ "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error",
+ "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable",
+ "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error"
+ ],
+ "enum": [
+ "OK",
+ "CANCELLED",
+ "UNKNOWN",
+ "INVALID_ARGUMENT",
+ "DEADLINE_EXCEEDED",
+ "NOT_FOUND",
+ "ALREADY_EXISTS",
+ "PERMISSION_DENIED",
+ "UNAUTHENTICATED",
+ "RESOURCE_EXHAUSTED",
+ "FAILED_PRECONDITION",
+ "ABORTED",
+ "OUT_OF_RANGE",
+ "UNIMPLEMENTED",
+ "INTERNAL",
+ "UNAVAILABLE",
+ "DATA_LOSS"
+ ],
+ "description": "Required."
+ }
+ }
+ },
+ "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": "TransferCounters"
+ "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.",
+ "type": "object",
+ "properties": {
+ "bucketName": {
+ "description": "Google Cloud Storage bucket name (see\n[Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nRequired.",
+ "type": "string"
+ }
+ },
+ "id": "GcsData"
+ },
+ "ListTransferJobsResponse": {
+ "description": "Response from ListTransferJobs.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "The list next page token."
+ },
+ "transferJobs": {
+ "items": {
+ "$ref": "TransferJob"
+ },
+ "type": "array",
+ "description": "A list of transfer jobs."
+ }
+ },
+ "id": "ListTransferJobsResponse"
+ },
+ "UpdateTransferJobRequest": {
+ "id": "UpdateTransferJobRequest",
+ "description": "Request passed to UpdateTransferJob.",
+ "type": "object",
+ "properties": {
+ "transferJob": {
+ "$ref": "TransferJob",
+ "description": "The job to update. `transferJob` is expected to specify only three fields:\n`description`, `transferSpec`, and `status`. An UpdateTransferJobRequest\nthat specifies other fields will be rejected with an error\n`INVALID_ARGUMENT`.\nRequired."
+ },
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
+ "type": "string"
+ },
+ "updateTransferJobFieldMask": {
+ "format": "google-fieldmask",
+ "description": "The field mask of the fields in `transferJob` that are to be updated in\nthis request. Fields in `transferJob` that can be updated are:\n`description`, `transferSpec`, and `status`. To update the `transferSpec`\nof the job, a complete transfer specification has to be provided. An\nincomplete specification which misses any required fields will be rejected\nwith the error `INVALID_ARGUMENT`.",
+ "type": "string"
+ }
+ }
+ },
+ "ObjectConditions": {
+ "description": "Conditions that determine which objects will be transferred.",
+ "type": "object",
+ "properties": {
+ "maxTimeElapsedSinceLastModification": {
+ "format": "google-duration",
+ "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.",
+ "type": "string"
+ },
+ "includePrefixes": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "If `includePrefixes` is specified, objects that satisfy the object\nconditions must have names that start with one of the `includePrefixes`\nand that do not start with any of the `excludePrefixes`. If `includePrefixes`\nis not specified, all objects except those that have names starting with\none of the `excludePrefixes` must satisfy the object conditions.\n\nRequirements:\n\n * Each include-prefix and exclude-prefix can contain any sequence of\n Unicode characters, of max length 1024 bytes when UTF8-encoded, and\n must not contain Carriage Return or Line Feed characters. Wildcard\n matching and regular expression matching are not supported.\n\n * Each include-prefix and exclude-prefix must omit the leading slash.\n For example, to include the `requests.gz` object in a transfer from\n `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include\n prefix as `logs/y=2015/requests.gz`.\n\n * None of the include-prefix or the exclude-prefix values can be empty,\n if specified.\n\n * Each include-prefix must include a distinct portion of the object\n namespace, i.e., no include-prefix may be a prefix of another\n include-prefix.\n\n * Each exclude-prefix must exclude a distinct portion of the object\n namespace, i.e., no exclude-prefix may be a prefix of another\n exclude-prefix.\n\n * If `includePrefixes` is specified, then each exclude-prefix must start\n with the value of a path explicitly included by `includePrefixes`.\n\nThe max size of `includePrefixes` is 1000."
+ },
+ "excludePrefixes": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "`excludePrefixes` must follow the requirements described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 1000."
+ },
+ "minTimeElapsedSinceLastModification": {
+ "format": "google-duration",
+ "description": "If unspecified, `minTimeElapsedSinceLastModification` takes a zero value\nand `maxTimeElapsedSinceLastModification` takes the maximum possible\nvalue of Duration. Objects that satisfy the object conditions\nmust either have a `lastModificationTime` greater or equal to\n`NOW` - `maxTimeElapsedSinceLastModification` and less than\n`NOW` - `minTimeElapsedSinceLastModification`, or not have a\n`lastModificationTime`.",
+ "type": "string"
+ }
+ },
+ "id": "ObjectConditions"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "done": {
+ "type": "boolean",
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable."
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that 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."
+ },
+ "metadata": {
+ "description": "Represents the transfer operation object.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Operation"
+ },
+ "TransferSpec": {
+ "description": "Configuration for running a transfer.",
+ "type": "object",
+ "properties": {
+ "gcsDataSource": {
+ "$ref": "GcsData",
+ "description": "A Google Cloud Storage data source."
+ },
+ "transferOptions": {
+ "description": "If the option `deleteObjectsUniqueInSink` is `true`, object conditions\nbased on objects' `lastModificationTime` are ignored and do not exclude\nobjects in a data source or a data sink.",
+ "$ref": "TransferOptions"
+ },
+ "awsS3DataSource": {
+ "description": "An AWS S3 data source.",
+ "$ref": "AwsS3Data"
+ },
+ "httpDataSource": {
+ "$ref": "HttpData",
+ "description": "An HTTP URL data source."
+ },
+ "objectConditions": {
+ "$ref": "ObjectConditions",
+ "description": "Only objects that satisfy these object conditions are included in the set\nof data source and data sink objects. Object conditions based on\nobjects' `lastModificationTime` do not exclude objects in a data sink."
+ },
+ "gcsDataSink": {
+ "$ref": "GcsData",
+ "description": "A Google Cloud Storage data sink."
+ }
+ },
+ "id": "TransferSpec"
+ },
+ "TransferOptions": {
+ "id": "TransferOptions",
+ "description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
+ "type": "object",
+ "properties": {
+ "deleteObjectsFromSourceAfterTransfer": {
+ "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink. Note that this option and\n`deleteObjectsUniqueInSink` are mutually exclusive.",
+ "type": "boolean"
+ },
+ "deleteObjectsUniqueInSink": {
+ "description": "Whether objects that exist only in the sink should be deleted. Note that\nthis option and `deleteObjectsFromSourceAfterTransfer` are mutually\nexclusive.",
+ "type": "boolean"
+ },
+ "overwriteObjectsAlreadyExistingInSink": {
+ "type": "boolean",
+ "description": "Whether overwriting objects that already exist in the sink is allowed."
+ }
+ }
}
- }
+ },
+ "protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "version": "v1",
+ "baseUrl": "https://storagetransfer.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
+ "servicePath": ""
}
diff --git a/streetviewpublish/v1/streetviewpublish-api.json b/streetviewpublish/v1/streetviewpublish-api.json
index a37d106..4789b46 100644
--- a/streetviewpublish/v1/streetviewpublish-api.json
+++ b/streetviewpublish/v1/streetviewpublish-api.json
@@ -1,149 +1,348 @@
{
- "schemas": {
- "BatchUpdatePhotosResponse": {
- "description": "Response to batch update of metadata of one or more\nPhotos.",
- "type": "object",
- "properties": {
- "results": {
- "description": "List of results for each individual\nPhoto updated, in the same order as\nthe request.",
- "items": {
- "$ref": "PhotoResponse"
+ "resources": {
+ "photos": {
+ "methods": {
+ "batchGet": {
+ "response": {
+ "$ref": "BatchGetPhotosResponse"
},
- "type": "array"
- }
- },
- "id": "BatchUpdatePhotosResponse"
- },
- "BatchDeletePhotosResponse": {
- "description": "Response to batch delete of one or more\nPhotos.",
- "type": "object",
- "properties": {
- "status": {
- "description": "The status for the operation to delete a single\nPhoto in the batch request.",
- "items": {
- "$ref": "Status"
- },
- "type": "array"
- }
- },
- "id": "BatchDeletePhotosResponse"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "INCLUDE_DOWNLOAD_URL"
+ ],
+ "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.",
+ "type": "string"
+ },
+ "photoIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
+ "type": "string"
}
},
- "type": "array"
+ "flatPath": "v1/photos:batchGet",
+ "id": "streetviewpublish.photos.batchGet",
+ "path": "v1/photos:batchGet",
+ "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo."
},
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- }
- },
- "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": {}
- },
- "Level": {
- "properties": {
- "number": {
- "format": "double",
- "description": "Floor number, used for ordering. 0 indicates the ground level, 1 indicates\nthe first level above ground level, -1 indicates the first level under\nground level. Non-integer values are OK.",
- "type": "number"
+ "list": {
+ "description": "Lists all the Photos that belong to the user.",
+ "response": {
+ "$ref": "ListPhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The\nnextPageToken\nvalue returned from a previous\nListPhotos\nrequest, if any.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of photos to return.\n`pageSize` must be non-negative. If `pageSize` is zero or is not provided,\nthe default page size of 100 will be used.\nThe number of photos returned in the response may be less than `pageSize`\nif the number of photos that belong to the user is less than `pageSize`.",
+ "type": "integer",
+ "location": "query"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "INCLUDE_DOWNLOAD_URL"
+ ],
+ "description": "Specifies if a download URL for the photos bytes should be returned in the\nPhotos response.",
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photos",
+ "id": "streetviewpublish.photos.list",
+ "path": "v1/photos"
},
- "name": {
- "description": "Required. A name assigned to this Level, restricted to 3 characters.\nConsider how the elevator buttons would be labeled for this level if there\nwas an elevator.",
- "type": "string"
- }
- },
- "id": "Level",
- "description": "Level information containing level number and its corresponding name.",
- "type": "object"
- },
- "UploadRef": {
- "type": "object",
- "properties": {
- "uploadUrl": {
- "description": "Required. An upload reference should be unique for each user. It follows\nthe form:\n\"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"",
- "type": "string"
- }
- },
- "id": "UploadRef",
- "description": "Upload reference for media files."
- },
- "Place": {
- "id": "Place",
- "description": "Place metadata for an entity.",
- "type": "object",
- "properties": {
- "placeId": {
- "type": "string",
- "description": "Required. Place identifier, as described in\nhttps://developers.google.com/places/place-id."
+ "batchDelete": {
+ "request": {
+ "$ref": "BatchDeletePhotosRequest"
+ },
+ "description": "Deletes a list of Photos and their metadata.\n\nNote that if\nBatchDeletePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchDeletePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchDeletePhotosResponse.results.\nSee\nDeletePhoto\nfor specific failures that can occur per photo.",
+ "response": {
+ "$ref": "BatchDeletePhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {},
+ "flatPath": "v1/photos:batchDelete",
+ "id": "streetviewpublish.photos.batchDelete",
+ "path": "v1/photos:batchDelete"
+ },
+ "batchUpdate": {
+ "flatPath": "v1/photos:batchUpdate",
+ "id": "streetviewpublish.photos.batchUpdate",
+ "path": "v1/photos:batchUpdate",
+ "description": "Updates the metadata of Photos, such\nas pose, place association, connections, etc. Changing the pixels of photos\nis not supported.\n\nNote that if\nBatchUpdatePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchUpdatePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchUpdatePhotosResponse.results.\nSee\nUpdatePhoto\nfor specific failures that can occur per photo.",
+ "request": {
+ "$ref": "BatchUpdatePhotosRequest"
+ },
+ "response": {
+ "$ref": "BatchUpdatePhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ]
}
}
},
- "BatchGetPhotosResponse": {
- "description": "Response to batch get of Photos.",
- "type": "object",
- "properties": {
- "results": {
- "items": {
- "$ref": "PhotoResponse"
+ "photo": {
+ "methods": {
+ "delete": {
+ "parameterOrder": [
+ "photoId"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
},
- "type": "array",
- "description": "List of results for each individual\nPhoto requested, in the same order as\nthe requests in\nBatchGetPhotos."
- }
- },
- "id": "BatchGetPhotosResponse"
- },
- "LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
- "properties": {
- "latitude": {
- "format": "double",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "type": "number"
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {
+ "photoId": {
+ "location": "path",
+ "description": "Required. ID of the Photo.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/photo/{photoId}",
+ "id": "streetviewpublish.photo.delete",
+ "path": "v1/photo/{photoId}",
+ "description": "Deletes a Photo and its metadata.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.NOT_FOUND if the photo ID does not exist."
},
- "longitude": {
- "type": "number",
- "format": "double",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0]."
- }
- },
- "id": "LatLng"
- },
- "BatchDeletePhotosRequest": {
- "properties": {
- "photoIds": {
- "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
- "items": {
- "type": "string"
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "photoId"
+ ],
+ "response": {
+ "$ref": "Photo"
},
- "type": "array"
+ "parameters": {
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "INCLUDE_DOWNLOAD_URL"
+ ],
+ "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.",
+ "type": "string"
+ },
+ "photoId": {
+ "location": "path",
+ "description": "Required. ID of the Photo.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photo/{photoId}",
+ "path": "v1/photo/{photoId}",
+ "id": "streetviewpublish.photo.get",
+ "description": "Gets the metadata of the specified\nPhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested Photo.\n* google.rpc.Code.NOT_FOUND if the requested\nPhoto does not exist."
+ },
+ "update": {
+ "flatPath": "v1/photo/{id}",
+ "id": "streetviewpublish.photo.update",
+ "path": "v1/photo/{id}",
+ "description": "Updates the metadata of a Photo, such\nas pose, place association, connections, etc. Changing the pixels of a\nphoto is not supported.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the requested photo does not exist.",
+ "request": {
+ "$ref": "Photo"
+ },
+ "response": {
+ "$ref": "Photo"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "id": {
+ "description": "Required. A base64 encoded identifier.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo metadata will be entirely replaced with the\nnew Photo metadata in this request. The update fails if invalid fields are\nspecified. Multiple fields can be specified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latlngpair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and\ngoogle.streetview.publish.v1.UpdatePhotoRequest.photo.connections is\nempty, all connections will be removed.\u003c/aside\u003e",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ]
+ },
+ "create": {
+ "flatPath": "v1/photo",
+ "id": "streetviewpublish.photo.create",
+ "path": "v1/photo",
+ "description": "After the client finishes uploading the photo with the returned\nUploadRef,\nCreatePhoto\npublishes the uploaded Photo to\nStreet View on Google Maps.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the upload reference does not exist.\n* google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the\nstorage limit.",
+ "request": {
+ "$ref": "Photo"
+ },
+ "response": {
+ "$ref": "Photo"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ]
+ },
+ "startUpload": {
+ "description": "Creates an upload session to start uploading photo bytes. The upload URL of\nthe returned UploadRef is used to\nupload the bytes for the Photo.\n\nIn addition to the photo requirements shown in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604,\nthe photo must also meet the following requirements:\n\n* Photo Sphere XMP metadata must be included in the photo medadata. See\nhttps://developers.google.com/streetview/spherical-metadata for the\nrequired fields.\n* The pixel size of the photo must meet the size requirements listed in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and\nthe photo must be a full 360 horizontally.\n\nAfter the upload is complete, the\nUploadRef is used with\nCreatePhoto\nto create the Photo object entry.",
+ "request": {
+ "$ref": "Empty"
+ },
+ "response": {
+ "$ref": "UploadRef"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photo:startUpload",
+ "id": "streetviewpublish.photo.startUpload",
+ "path": "v1/photo:startUpload"
}
- },
- "id": "BatchDeletePhotosRequest",
- "description": "Request to delete multiple Photos.",
- "type": "object"
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "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": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://streetviewpublish.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.\n",
+ "servicePath": "",
+ "basePath": "",
+ "id": "streetviewpublish:v1",
+ "documentationLink": "https://developers.google.com/streetview/publish/",
+ "revision": "20170722",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
"UpdatePhotoRequest": {
"description": "Request to update the metadata of a\nPhoto. Updating the pixels of a photo\nis not supported.",
"type": "object",
@@ -164,19 +363,10 @@
"description": "Raw pose measurement for an entity.",
"type": "object",
"properties": {
- "roll": {
- "format": "double",
- "description": "Roll, measured in degrees. Value must be \u003e= 0 and \u003c360. A value of 0\nmeans level with the horizon.\nNaN indicates an unmeasured quantity.",
- "type": "number"
- },
- "level": {
- "description": "Level (the floor in a building) used to configure vertical navigation.",
- "$ref": "Level"
- },
"heading": {
+ "type": "number",
"format": "double",
- "description": "Compass heading, measured at the center of the photo in degrees clockwise\nfrom North. Value must be \u003e=0 and \u003c360.\nNaN indicates an unmeasured quantity.",
- "type": "number"
+ "description": "Compass heading, measured at the center of the photo in degrees clockwise\nfrom North. Value must be \u003e=0 and \u003c360.\nNaN indicates an unmeasured quantity."
},
"altitude": {
"format": "double",
@@ -191,6 +381,15 @@
"latLngPair": {
"$ref": "LatLng",
"description": "Latitude and longitude pair of the pose, as explained here:\nhttps://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng\nWhen creating a Photo, if the\nlatitude and longitude pair are not provided here, the geolocation from the\nexif header will be used. If the latitude and longitude pair is not\nprovided and cannot be found in the exif header, the create photo process\nwill fail."
+ },
+ "roll": {
+ "format": "double",
+ "description": "Roll, measured in degrees. Value must be \u003e= 0 and \u003c360. A value of 0\nmeans level with the horizon.\nNaN indicates an unmeasured quantity.",
+ "type": "number"
+ },
+ "level": {
+ "description": "Level (the floor in a building) used to configure vertical navigation.",
+ "$ref": "Level"
}
},
"id": "Pose"
@@ -207,6 +406,7 @@
"id": "PhotoId"
},
"BatchUpdatePhotosRequest": {
+ "id": "BatchUpdatePhotosRequest",
"description": "Request to update the metadata of photos.\nUpdating the pixels of photos is not supported.",
"type": "object",
"properties": {
@@ -217,10 +417,10 @@
},
"type": "array"
}
- },
- "id": "BatchUpdatePhotosRequest"
+ }
},
"ListPhotosResponse": {
+ "description": "Response to list all photos that belong to a user.",
"type": "object",
"properties": {
"photos": {
@@ -235,13 +435,42 @@
"type": "string"
}
},
- "id": "ListPhotosResponse",
- "description": "Response to list all photos that belong to a user."
+ "id": "ListPhotosResponse"
},
"Photo": {
"description": "Photo is used to store 360 photos along with photo metadata.",
"type": "object",
"properties": {
+ "pose": {
+ "description": "Pose of the photo.",
+ "$ref": "Pose"
+ },
+ "photoId": {
+ "$ref": "PhotoId",
+ "description": "Required when updating photo. Output only when creating photo.\nIdentifier for the photo, which is unique among all photos in\nGoogle."
+ },
+ "uploadReference": {
+ "$ref": "UploadRef",
+ "description": "Required when creating photo. Input only. The resource URL where the photo\nbytes are uploaded to."
+ },
+ "shareLink": {
+ "description": "Output only. The share link for the photo.",
+ "type": "string"
+ },
+ "captureTime": {
+ "format": "google-datetime",
+ "description": "Absolute time when the photo was captured.\nWhen the photo has no exif timestamp, this is used to set a timestamp in\nthe photo metadata.",
+ "type": "string"
+ },
+ "thumbnailUrl": {
+ "description": "Output only. The thumbnail URL for showing a preview of the given photo.",
+ "type": "string"
+ },
+ "viewCount": {
+ "format": "int64",
+ "description": "Output only. View count of the photo.",
+ "type": "string"
+ },
"downloadUrl": {
"description": "Output only. The download URL for the photo bytes. This field is set only\nwhen\nGetPhotoRequest.view\nis set to\nPhotoView.INCLUDE_DOWNLOAD_URL.",
"type": "string"
@@ -259,72 +488,186 @@
"$ref": "Connection"
},
"type": "array"
- },
- "pose": {
- "$ref": "Pose",
- "description": "Pose of the photo."
- },
- "photoId": {
- "$ref": "PhotoId",
- "description": "Required when updating photo. Output only when creating photo.\nIdentifier for the photo, which is unique among all photos in\nGoogle."
- },
- "uploadReference": {
- "$ref": "UploadRef",
- "description": "Required when creating photo. Input only. The resource URL where the photo\nbytes are uploaded to."
- },
- "shareLink": {
- "type": "string",
- "description": "Output only. The share link for the photo."
- },
- "captureTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Absolute time when the photo was captured.\nWhen the photo has no exif timestamp, this is used to set a timestamp in\nthe photo metadata."
- },
- "thumbnailUrl": {
- "description": "Output only. The thumbnail URL for showing a preview of the given photo.",
- "type": "string"
- },
- "viewCount": {
- "format": "int64",
- "description": "Output only. View count of the photo.",
- "type": "string"
}
},
"id": "Photo"
},
"PhotoResponse": {
+ "description": "Response payload for a single\nPhoto\nin batch operations including\nBatchGetPhotos\nand\nBatchUpdatePhotos.",
"type": "object",
"properties": {
"status": {
- "$ref": "Status",
- "description": "The status for the operation to get or update a single photo in the batch\nrequest."
+ "description": "The status for the operation to get or update a single photo in the batch\nrequest.",
+ "$ref": "Status"
},
"photo": {
- "$ref": "Photo",
- "description": "The Photo resource, if the request\nwas successful."
+ "description": "The Photo resource, if the request\nwas successful.",
+ "$ref": "Photo"
}
},
- "id": "PhotoResponse",
- "description": "Response payload for a single\nPhoto\nin batch operations including\nBatchGetPhotos\nand\nBatchUpdatePhotos."
+ "id": "PhotoResponse"
},
"Connection": {
"description": "A connection is the link from a source photo to a destination photo.",
"type": "object",
"properties": {
"target": {
- "description": "Required. The destination of the connection from the containing photo to\nanother photo.",
- "$ref": "PhotoId"
+ "$ref": "PhotoId",
+ "description": "Required. The destination of the connection from the containing photo to\nanother photo."
}
},
"id": "Connection"
+ },
+ "BatchUpdatePhotosResponse": {
+ "description": "Response to batch update of metadata of one or more\nPhotos.",
+ "type": "object",
+ "properties": {
+ "results": {
+ "description": "List of results for each individual\nPhoto updated, in the same order as\nthe request.",
+ "items": {
+ "$ref": "PhotoResponse"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchUpdatePhotosResponse"
+ },
+ "BatchDeletePhotosResponse": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The status for the operation to delete a single\nPhoto in the batch request.",
+ "items": {
+ "$ref": "Status"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchDeletePhotosResponse",
+ "description": "Response to batch delete of one or more\nPhotos."
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code."
+ }
+ },
+ "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": {}
+ },
+ "Level": {
+ "description": "Level information containing level number and its corresponding name.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Required. A name assigned to this Level, restricted to 3 characters.\nConsider how the elevator buttons would be labeled for this level if there\nwas an elevator.",
+ "type": "string"
+ },
+ "number": {
+ "format": "double",
+ "description": "Floor number, used for ordering. 0 indicates the ground level, 1 indicates\nthe first level above ground level, -1 indicates the first level under\nground level. Non-integer values are OK.",
+ "type": "number"
+ }
+ },
+ "id": "Level"
+ },
+ "BatchGetPhotosResponse": {
+ "properties": {
+ "results": {
+ "description": "List of results for each individual\nPhoto requested, in the same order as\nthe requests in\nBatchGetPhotos.",
+ "items": {
+ "$ref": "PhotoResponse"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchGetPhotosResponse",
+ "description": "Response to batch get of Photos.",
+ "type": "object"
+ },
+ "Place": {
+ "description": "Place metadata for an entity.",
+ "type": "object",
+ "properties": {
+ "placeId": {
+ "description": "Required. Place identifier, as described in\nhttps://developers.google.com/places/place-id.",
+ "type": "string"
+ }
+ },
+ "id": "Place"
+ },
+ "UploadRef": {
+ "properties": {
+ "uploadUrl": {
+ "description": "Required. An upload reference should be unique for each user. It follows\nthe form:\n\"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"",
+ "type": "string"
+ }
+ },
+ "id": "UploadRef",
+ "description": "Upload reference for media files.",
+ "type": "object"
+ },
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object",
+ "properties": {
+ "latitude": {
+ "format": "double",
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "type": "number"
+ },
+ "longitude": {
+ "format": "double",
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "type": "number"
+ }
+ },
+ "id": "LatLng"
+ },
+ "BatchDeletePhotosRequest": {
+ "description": "Request to delete multiple Photos.",
+ "type": "object",
+ "properties": {
+ "photoIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`."
+ }
+ },
+ "id": "BatchDeletePhotosRequest"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Street View Publish",
"auth": {
"oauth2": {
@@ -341,348 +684,5 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Street View Publish API",
- "ownerName": "Google",
- "resources": {
- "photo": {
- "methods": {
- "create": {
- "path": "v1/photo",
- "id": "streetviewpublish.photo.create",
- "request": {
- "$ref": "Photo"
- },
- "description": "After the client finishes uploading the photo with the returned\nUploadRef,\nCreatePhoto\npublishes the uploaded Photo to\nStreet View on Google Maps.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the upload reference does not exist.\n* google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the\nstorage limit.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Photo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photo"
- },
- "startUpload": {
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photo:startUpload",
- "id": "streetviewpublish.photo.startUpload",
- "path": "v1/photo:startUpload",
- "request": {
- "$ref": "Empty"
- },
- "description": "Creates an upload session to start uploading photo bytes. The upload URL of\nthe returned UploadRef is used to\nupload the bytes for the Photo.\n\nIn addition to the photo requirements shown in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604,\nthe photo must also meet the following requirements:\n\n* Photo Sphere XMP metadata must be included in the photo medadata. See\nhttps://developers.google.com/streetview/spherical-metadata for the\nrequired fields.\n* The pixel size of the photo must meet the size requirements listed in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and\nthe photo must be a full 360 horizontally.\n\nAfter the upload is complete, the\nUploadRef is used with\nCreatePhoto\nto create the Photo object entry.",
- "response": {
- "$ref": "UploadRef"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- },
- "delete": {
- "id": "streetviewpublish.photo.delete",
- "path": "v1/photo/{photoId}",
- "description": "Deletes a Photo and its metadata.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.NOT_FOUND if the photo ID does not exist.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "photoId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "photoId": {
- "location": "path",
- "description": "Required. ID of the Photo.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photo/{photoId}"
- },
- "get": {
- "path": "v1/photo/{photoId}",
- "id": "streetviewpublish.photo.get",
- "description": "Gets the metadata of the specified\nPhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested Photo.\n* google.rpc.Code.NOT_FOUND if the requested\nPhoto does not exist.",
- "httpMethod": "GET",
- "parameterOrder": [
- "photoId"
- ],
- "response": {
- "$ref": "Photo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {
- "view": {
- "enum": [
- "BASIC",
- "INCLUDE_DOWNLOAD_URL"
- ],
- "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.",
- "type": "string",
- "location": "query"
- },
- "photoId": {
- "location": "path",
- "description": "Required. ID of the Photo.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/photo/{photoId}"
- },
- "update": {
- "request": {
- "$ref": "Photo"
- },
- "description": "Updates the metadata of a Photo, such\nas pose, place association, connections, etc. Changing the pixels of a\nphoto is not supported.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the requested photo does not exist.",
- "response": {
- "$ref": "Photo"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo metadata will be entirely replaced with the\nnew Photo metadata in this request. The update fails if invalid fields are\nspecified. Multiple fields can be specified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latlngpair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and\ngoogle.streetview.publish.v1.UpdatePhotoRequest.photo.connections is\nempty, all connections will be removed.\u003c/aside\u003e",
- "type": "string",
- "location": "query"
- },
- "id": {
- "location": "path",
- "description": "Required. A base64 encoded identifier.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/photo/{id}",
- "id": "streetviewpublish.photo.update",
- "path": "v1/photo/{id}"
- }
- }
- },
- "photos": {
- "methods": {
- "list": {
- "description": "Lists all the Photos that belong to the user.",
- "response": {
- "$ref": "ListPhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {
- "filter": {
- "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The\nnextPageToken\nvalue returned from a previous\nListPhotos\nrequest, if any.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of photos to return.\n`pageSize` must be non-negative. If `pageSize` is zero or is not provided,\nthe default page size of 100 will be used.\nThe number of photos returned in the response may be less than `pageSize`\nif the number of photos that belong to the user is less than `pageSize`.",
- "type": "integer"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "INCLUDE_DOWNLOAD_URL"
- ],
- "description": "Specifies if a download URL for the photos bytes should be returned in the\nPhotos response.",
- "type": "string"
- }
- },
- "flatPath": "v1/photos",
- "id": "streetviewpublish.photos.list",
- "path": "v1/photos"
- },
- "batchDelete": {
- "request": {
- "$ref": "BatchDeletePhotosRequest"
- },
- "description": "Deletes a list of Photos and their metadata.\n\nNote that if\nBatchDeletePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchDeletePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchDeletePhotosResponse.results.\nSee\nDeletePhoto\nfor specific failures that can occur per photo.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "BatchDeletePhotosResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photos:batchDelete",
- "path": "v1/photos:batchDelete",
- "id": "streetviewpublish.photos.batchDelete"
- },
- "batchUpdate": {
- "response": {
- "$ref": "BatchUpdatePhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photos:batchUpdate",
- "id": "streetviewpublish.photos.batchUpdate",
- "path": "v1/photos:batchUpdate",
- "description": "Updates the metadata of Photos, such\nas pose, place association, connections, etc. Changing the pixels of photos\nis not supported.\n\nNote that if\nBatchUpdatePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchUpdatePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchUpdatePhotosResponse.results.\nSee\nUpdatePhoto\nfor specific failures that can occur per photo.",
- "request": {
- "$ref": "BatchUpdatePhotosRequest"
- }
- },
- "batchGet": {
- "response": {
- "$ref": "BatchGetPhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "photoIds": {
- "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "INCLUDE_DOWNLOAD_URL"
- ],
- "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photos:batchGet",
- "id": "streetviewpublish.photos.batchGet",
- "path": "v1/photos:batchGet",
- "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo."
- }
- }
- }
- },
- "parameters": {
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "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": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://streetviewpublish.googleapis.com/",
- "servicePath": "",
- "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.\n",
- "kind": "discovery#restDescription",
- "basePath": "",
- "revision": "20170722",
- "documentationLink": "https://developers.google.com/streetview/publish/",
- "id": "streetviewpublish:v1",
- "discoveryVersion": "v1",
- "version_module": "True"
+ "ownerName": "Google"
}
diff --git a/translate/v2/translate-api.json b/translate/v2/translate-api.json
index c99c80f..64aa35a 100644
--- a/translate/v2/translate-api.json
+++ b/translate/v2/translate-api.json
@@ -1,19 +1,4 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-translation": {
- "description": "Translate text from one language to another using Google Translate"
- }
- }
- }
- },
- "rootUrl": "https://translation.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "translate",
"batchPath": "batch/translate",
"title": "Google Cloud Translation API",
"features": [
@@ -21,121 +6,14 @@
],
"ownerName": "Google",
"resources": {
- "languages": {
- "methods": {
- "list": {
- "description": "Returns a list of supported languages for translation.",
- "response": {
- "$ref": "LanguagesListResponse"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "target": {
- "description": "The language to use to return localized, human readable names of supported\nlanguages.",
- "type": "string",
- "location": "query"
- },
- "model": {
- "location": "query",
- "description": "The model type for which supported languages should be returned.",
- "type": "string"
- }
- },
- "path": "v2/languages",
- "id": "language.languages.list"
- }
- }
- },
- "translations": {
- "methods": {
- "list": {
- "path": "v2",
- "id": "language.translations.list",
- "description": "Translates input text, returning translated text.",
- "httpMethod": "GET",
- "response": {
- "$ref": "TranslationsListResponse"
- },
- "parameterOrder": [
- "q",
- "target"
- ],
- "parameters": {
- "q": {
- "repeated": true,
- "location": "query",
- "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
- "required": true,
- "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",
- "location": "query"
- },
- "cid": {
- "repeated": true,
- "location": "query",
- "description": "The customization id for translate",
- "type": "string"
- },
- "target": {
- "location": "query",
- "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
- "required": true,
- "type": "string"
- },
- "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",
- "enumDescriptions": [
- "Specifies the input is in HTML",
- "Specifies the input is in plain textual format"
- ],
- "location": "query",
- "enum": [
- "html",
- "text"
- ]
- },
- "model": {
- "location": "query",
- "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "translate": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "path": "v2",
- "id": "language.translations.translate",
- "request": {
- "$ref": "TranslateTextRequest"
- },
- "description": "Translates input text, returning translated text.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "TranslationsListResponse"
- }
- }
- }
- },
"detections": {
"methods": {
"detect": {
+ "response": {
+ "$ref": "DetectionsListResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-translation",
"https://www.googleapis.com/auth/cloud-platform"
@@ -146,30 +24,54 @@
"description": "Detects the language of text within a request.",
"request": {
"$ref": "DetectLanguageRequest"
- },
- "response": {
- "$ref": "DetectionsListResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
+ }
},
"list": {
- "id": "language.detections.list",
- "path": "v2/detect",
- "description": "Detects the language of text within a request.",
+ "httpMethod": "GET",
"response": {
"$ref": "DetectionsListResponse"
},
"parameterOrder": [
"q"
],
- "httpMethod": "GET",
"parameters": {
"q": {
- "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
"required": true,
"type": "string",
"repeated": true,
+ "location": "query",
+ "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "path": "v2/detect",
+ "id": "language.detections.list",
+ "description": "Detects the language of text within a request."
+ }
+ }
+ },
+ "languages": {
+ "methods": {
+ "list": {
+ "path": "v2/languages",
+ "id": "language.languages.list",
+ "description": "Returns a list of supported languages for translation.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LanguagesListResponse"
+ },
+ "parameters": {
+ "model": {
+ "type": "string",
+ "location": "query",
+ "description": "The model type for which supported languages should be returned."
+ },
+ "target": {
+ "description": "The language to use to return localized, human readable names of supported\nlanguages.",
+ "type": "string",
"location": "query"
}
},
@@ -179,13 +81,117 @@
]
}
}
+ },
+ "translations": {
+ "methods": {
+ "translate": {
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "id": "language.translations.translate",
+ "path": "v2",
+ "request": {
+ "$ref": "TranslateTextRequest"
+ },
+ "description": "Translates input text, returning translated text."
+ },
+ "list": {
+ "description": "Translates input text, returning translated text.",
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "parameterOrder": [
+ "q",
+ "target"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "source": {
+ "type": "string",
+ "location": "query",
+ "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response."
+ },
+ "cid": {
+ "location": "query",
+ "description": "The customization id for translate",
+ "type": "string",
+ "repeated": true
+ },
+ "target": {
+ "location": "query",
+ "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
+ "required": true,
+ "type": "string"
+ },
+ "format": {
+ "type": "string",
+ "enumDescriptions": [
+ "Specifies the input is in HTML",
+ "Specifies the input is in plain textual format"
+ ],
+ "location": "query",
+ "enum": [
+ "html",
+ "text"
+ ],
+ "description": "The format of the source text, in either HTML (default) or plain-text. A\nvalue of \"html\" indicates HTML and a value of \"text\" indicates plain-text."
+ },
+ "model": {
+ "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
+ "type": "string",
+ "location": "query"
+ },
+ "q": {
+ "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
+ "required": true,
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "id": "language.translations.list",
+ "path": "v2"
+ }
+ }
}
},
"parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -222,14 +228,14 @@
"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. Overrides userIp if both are provided.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -238,106 +244,28 @@
"location": "query"
},
"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.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "uploadType": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
}
},
"version": "v2",
"baseUrl": "https://translation.googleapis.com/language/translate/",
"servicePath": "language/translate/",
- "description": "The Google Cloud Translation API lets websites and programs integrate with\n Google Translate programmatically.",
"kind": "discovery#restDescription",
+ "description": "The Google Cloud Translation API lets websites and programs integrate with\n Google Translate programmatically.",
"basePath": "/language/translate/",
"revision": "20170525",
"documentationLink": "https://code.google.com/apis/language/translate/v2/getting_started.html",
"id": "translate:v2",
"discoveryVersion": "v1",
"schemas": {
- "LanguagesListResponse": {
- "id": "LanguagesListResponse",
- "type": "object",
- "properties": {
- "languages": {
- "description": "List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.",
- "items": {
- "$ref": "LanguagesResource"
- },
- "type": "array"
- }
- }
- },
- "TranslationsResource": {
- "type": "object",
- "properties": {
- "detectedSourceLanguage": {
- "description": "The source language of the initial request, detected automatically, if\nno source language was passed within the initial request. If the\nsource language was passed, auto-detection of the language will not\noccur and this field will be empty.",
- "type": "string"
- },
- "model": {
- "description": "The `model` type used for this translation. Valid values are\nlisted in public documentation. Can be different from requested `model`.\nPresent only if specific model type was explicitly requested.",
- "type": "string"
- },
- "translatedText": {
- "description": "Text translated into the target language.",
- "type": "string"
- }
- },
- "id": "TranslationsResource"
- },
- "DetectionsResource": {
- "description": "An array of languages which we detect for the given text The most likely language list first.",
- "items": {
- "type": "object",
- "properties": {
- "confidence": {
- "format": "float",
- "description": "The confidence of the detection result of this language.",
- "type": "number"
- },
- "language": {
- "description": "The language we detected.",
- "type": "string"
- },
- "isReliable": {
- "description": "A boolean to indicate is the language detection result reliable.",
- "type": "boolean"
- }
- }
- },
- "type": "array",
- "id": "DetectionsResource"
- },
"TranslationsListResponse": {
- "id": "TranslationsListResponse",
- "description": "The main language translation response message.",
- "type": "object",
"properties": {
"translations": {
"description": "Translations contains list of translation results of given text",
@@ -346,15 +274,18 @@
},
"type": "array"
}
- }
+ },
+ "id": "TranslationsListResponse",
+ "description": "The main language translation response message.",
+ "type": "object"
},
"TranslateTextRequest": {
"description": "The main translation request message for the Cloud Translation API.",
"type": "object",
"properties": {
"target": {
- "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
- "type": "string"
+ "type": "string",
+ "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support."
},
"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.",
@@ -379,7 +310,6 @@
"id": "TranslateTextRequest"
},
"DetectLanguageRequest": {
- "id": "DetectLanguageRequest",
"description": "The request message for language detection.",
"type": "object",
"properties": {
@@ -390,7 +320,8 @@
},
"type": "array"
}
- }
+ },
+ "id": "DetectLanguageRequest"
},
"LanguagesResource": {
"type": "object",
@@ -400,8 +331,8 @@
"type": "string"
},
"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"
+ "type": "string",
+ "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')"
}
},
"id": "LanguagesResource"
@@ -424,11 +355,65 @@
"type": "object",
"properties": {
"target": {
- "description": "The language to use to return localized, human readable names of supported\nlanguages.",
- "type": "string"
+ "type": "string",
+ "description": "The language to use to return localized, human readable names of supported\nlanguages."
}
},
"id": "GetSupportedLanguagesRequest"
+ },
+ "LanguagesListResponse": {
+ "type": "object",
+ "properties": {
+ "languages": {
+ "description": "List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.",
+ "items": {
+ "$ref": "LanguagesResource"
+ },
+ "type": "array"
+ }
+ },
+ "id": "LanguagesListResponse"
+ },
+ "TranslationsResource": {
+ "type": "object",
+ "properties": {
+ "translatedText": {
+ "description": "Text translated into the target language.",
+ "type": "string"
+ },
+ "detectedSourceLanguage": {
+ "description": "The source language of the initial request, detected automatically, if\nno source language was passed within the initial request. If the\nsource language was passed, auto-detection of the language will not\noccur and this field will be empty.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "TranslationsResource"
+ },
+ "DetectionsResource": {
+ "items": {
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "format": "float",
+ "description": "The confidence of the detection result of this language.",
+ "type": "number"
+ },
+ "language": {
+ "description": "The language we detected.",
+ "type": "string"
+ },
+ "isReliable": {
+ "description": "A boolean to indicate is the language detection result reliable.",
+ "type": "boolean"
+ }
+ }
+ },
+ "type": "array",
+ "id": "DetectionsResource",
+ "description": "An array of languages which we detect for the given text The most likely language list first."
}
},
"icons": {
@@ -436,5 +421,20 @@
"x32": "https://www.google.com/images/icons/product/translate-32.png"
},
"protocol": "rest",
- "canonicalName": "Translate"
+ "canonicalName": "Translate",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-translation": {
+ "description": "Translate text from one language to another using Google Translate"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://translation.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "translate"
}
diff --git a/vault/v1/vault-api.json b/vault/v1/vault-api.json
index 957ada4..5b174f8 100644
--- a/vault/v1/vault-api.json
+++ b/vault/v1/vault-api.json
@@ -1,63 +1,90 @@
{
- "version": "v1",
- "baseUrl": "https://vault.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "",
- "servicePath": "",
"basePath": "",
+ "id": "vault:v1",
"revision": "20170719",
"documentationLink": "https://apps.google.com/products/vault/",
- "id": "vault:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "Empty": {
+ "type": "object",
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ },
+ "ReopenMatterRequest": {
+ "description": "Reopen a matter by ID.",
+ "type": "object",
+ "properties": {},
+ "id": "ReopenMatterRequest"
+ },
+ "CloseMatterRequest": {
+ "description": "Close a matter by ID.",
+ "type": "object",
+ "properties": {},
+ "id": "CloseMatterRequest"
+ },
+ "RemoveMatterPermissionsRequest": {
+ "type": "object",
+ "properties": {
+ "accountId": {
+ "description": "The account ID.",
+ "type": "string"
+ }
+ },
+ "id": "RemoveMatterPermissionsRequest",
+ "description": "Remove an account as a matter collaborator."
+ },
"MatterPermission": {
+ "id": "MatterPermission",
"description": "Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist.",
"type": "object",
"properties": {
"accountId": {
- "description": "The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
- "type": "string"
+ "type": "string",
+ "description": "The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e."
},
"role": {
- "enumDescriptions": [
- "No role assigned.",
- "A collaborator to the matter.",
- "The owner of the matter."
- ],
"enum": [
"ROLE_UNSPECIFIED",
"COLLABORATOR",
"OWNER"
],
"description": "The user's role in this matter.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "No role assigned.",
+ "A collaborator to the matter.",
+ "The owner of the matter."
+ ]
}
- },
- "id": "MatterPermission"
+ }
},
"ListMattersResponse": {
+ "description": "Provides the list of matters.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Page token to retrieve the next page of results in the list.",
- "type": "string"
- },
"matters": {
"description": "List of matters.",
"items": {
"$ref": "Matter"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.",
+ "type": "string"
}
},
- "id": "ListMattersResponse",
- "description": "Provides the list of matters."
+ "id": "ListMattersResponse"
},
"HeldMailQuery": {
- "description": "Query options for mail holds.",
"type": "object",
"properties": {
+ "terms": {
+ "description": "The search terms for the hold.",
+ "type": "string"
+ },
"endTime": {
"format": "google-datetime",
"description": "The end date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
@@ -67,45 +94,21 @@
"format": "google-datetime",
"description": "The start date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
"type": "string"
- },
- "terms": {
- "description": "The search terms for the hold.",
- "type": "string"
}
},
- "id": "HeldMailQuery"
+ "id": "HeldMailQuery",
+ "description": "Query options for mail holds."
},
"CloseMatterResponse": {
- "id": "CloseMatterResponse",
- "description": "Response to a CloseMatterRequest.",
"type": "object",
"properties": {
"matter": {
- "description": "The updated matter, with state CLOSED.",
- "$ref": "Matter"
- }
- }
- },
- "HeldGroupsQuery": {
- "description": "Query options for group holds.",
- "type": "object",
- "properties": {
- "endTime": {
- "format": "google-datetime",
- "description": "The end date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The start date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
- "type": "string"
- },
- "terms": {
- "description": "The search terms for the hold.",
- "type": "string"
+ "$ref": "Matter",
+ "description": "The updated matter, with state CLOSED."
}
},
- "id": "HeldGroupsQuery"
+ "id": "CloseMatterResponse",
+ "description": "Response to a CloseMatterRequest."
},
"HeldDriveQuery": {
"description": "Query options for drive holds.",
@@ -118,44 +121,63 @@
},
"id": "HeldDriveQuery"
},
+ "HeldGroupsQuery": {
+ "description": "Query options for group holds.",
+ "type": "object",
+ "properties": {
+ "terms": {
+ "description": "The search terms for the hold.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The end date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
+ "type": "string"
+ }
+ },
+ "id": "HeldGroupsQuery"
+ },
"HeldOrgUnit": {
"description": "A organizational unit being held in a particular hold.\nThis structure is immutable.",
"type": "object",
"properties": {
+ "orgUnitId": {
+ "description": "The org unit's immutable ID as provided by the admin SDK.",
+ "type": "string"
+ },
"holdTime": {
"format": "google-datetime",
"description": "When the org unit was put on hold. This property is immutable.",
"type": "string"
- },
- "orgUnitId": {
- "description": "The org unit's immutable ID as provided by the admin SDK.",
- "type": "string"
}
},
"id": "HeldOrgUnit"
},
"AddMatterPermissionsRequest": {
- "description": "Add an account with the permission specified. The role cannot be owner.\nIf an account already has a role in the matter, it will be\noverwritten.",
"type": "object",
"properties": {
+ "sendEmails": {
+ "description": "True to send notification email to the added account.\nFalse to not send notification email.",
+ "type": "boolean"
+ },
"matterPermission": {
- "description": "The MatterPermission to add.",
- "$ref": "MatterPermission"
+ "$ref": "MatterPermission",
+ "description": "The MatterPermission to add."
},
"ccMe": {
"description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.",
"type": "boolean"
- },
- "sendEmails": {
- "description": "True to send notification email to the added account.\nFalse to not send notification email.",
- "type": "boolean"
}
},
- "id": "AddMatterPermissionsRequest"
+ "id": "AddMatterPermissionsRequest",
+ "description": "Add an account with the permission specified. The role cannot be owner.\nIf an account already has a role in the matter, it will be\noverwritten."
},
"Matter": {
- "description": "Represents a matter.",
- "type": "object",
"properties": {
"matterPermissions": {
"description": "List of users and access to the matter. Currently there is no programmer\ndefined limit on the number of permissions a matter can have.",
@@ -193,26 +215,27 @@
]
}
},
- "id": "Matter"
+ "id": "Matter",
+ "description": "Represents a matter.",
+ "type": "object"
},
"HeldAccount": {
- "id": "HeldAccount",
"description": "An account being held in a particular hold. This structure is immutable.\nThis can be either a single user or a google group, depending on the corpus.",
"type": "object",
"properties": {
"accountId": {
- "description": "The account's ID as provided by the\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
- "type": "string"
+ "type": "string",
+ "description": "The account's ID as provided by the\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e."
},
"holdTime": {
"format": "google-datetime",
"description": "When the account was put on hold.",
"type": "string"
}
- }
+ },
+ "id": "HeldAccount"
},
"ReopenMatterResponse": {
- "description": "Response to a ReopenMatterRequest.",
"type": "object",
"properties": {
"matter": {
@@ -220,43 +243,32 @@
"description": "The updated matter, with state OPEN."
}
},
- "id": "ReopenMatterResponse"
+ "id": "ReopenMatterResponse",
+ "description": "Response to a ReopenMatterRequest."
},
"CorpusQuery": {
"description": "Corpus specific queries.",
"type": "object",
"properties": {
"groupsQuery": {
- "description": "Details pertaining to Groups holds. If set, corpus must be Groups.",
- "$ref": "HeldGroupsQuery"
+ "$ref": "HeldGroupsQuery",
+ "description": "Details pertaining to Groups holds. If set, corpus must be Groups."
},
"mailQuery": {
"$ref": "HeldMailQuery",
"description": "Details pertaining to mail holds. If set, corpus must be mail."
},
"driveQuery": {
- "$ref": "HeldDriveQuery",
- "description": "Details pertaining to Drive holds. If set, corpus must be Drive."
+ "description": "Details pertaining to Drive holds. If set, corpus must be Drive.",
+ "$ref": "HeldDriveQuery"
}
},
"id": "CorpusQuery"
},
"Hold": {
+ "description": "Represents a hold within Vault. A hold restricts purging of\nartifacts based on the combination of the query and accounts restrictions.\nA hold can be configured to either apply to an explicitly configured set\nof accounts, or can be applied to all members of an organizational unit.",
"type": "object",
"properties": {
- "updateTime": {
- "format": "google-datetime",
- "description": "The last time this hold was modified.",
- "type": "string"
- },
- "holdId": {
- "description": "The unique immutable ID of the hold. Assigned during creation.",
- "type": "string"
- },
- "name": {
- "description": "The name of the hold.",
- "type": "string"
- },
"accounts": {
"description": "If set, the hold applies to the enumerated accounts and org_unit must be\nempty.",
"items": {
@@ -269,10 +281,12 @@
"description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype."
},
"orgUnit": {
- "$ref": "HeldOrgUnit",
- "description": "If set, the hold applies to all members of the organizational unit and\naccounts must be empty. This property is mutable. For groups holds,\nset the accounts field."
+ "description": "If set, the hold applies to all members of the organizational unit and\naccounts must be empty. This property is mutable. For groups holds,\nset the accounts field.",
+ "$ref": "HeldOrgUnit"
},
"corpus": {
+ "description": "The corpus to be searched.",
+ "type": "string",
"enumDescriptions": [
"No corpus specified.",
"Drive.",
@@ -284,37 +298,41 @@
"DRIVE",
"MAIL",
"GROUPS"
- ],
- "description": "The corpus to be searched.",
+ ]
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "The last time this hold was modified.",
+ "type": "string"
+ },
+ "holdId": {
+ "description": "The unique immutable ID of the hold. Assigned during creation.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the hold.",
"type": "string"
}
},
- "id": "Hold",
- "description": "Represents a hold within Vault. A hold restricts purging of\nartifacts based on the combination of the query and accounts restrictions.\nA hold can be configured to either apply to an explicitly configured set\nof accounts, or can be applied to all members of an organizational unit."
+ "id": "Hold"
},
"ListHoldsResponse": {
+ "description": "The holds for a matter.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.\nIf this is empty, then there are no more holds to list.",
+ "type": "string"
+ },
"holds": {
"description": "The list of holds.",
"items": {
"$ref": "Hold"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Page token to retrieve the next page of results in the list.\nIf this is empty, then there are no more holds to list.",
- "type": "string"
}
},
- "id": "ListHoldsResponse",
- "description": "The holds for a matter."
- },
- "UndeleteMatterRequest": {
- "description": "Undelete a matter by ID.",
- "type": "object",
- "properties": {},
- "id": "UndeleteMatterRequest"
+ "id": "ListHoldsResponse"
},
"ListHeldAccountsResponse": {
"description": "Returns a list of held accounts for a hold.",
@@ -330,39 +348,16 @@
},
"id": "ListHeldAccountsResponse"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "UndeleteMatterRequest": {
+ "description": "Undelete a matter by ID.",
"type": "object",
"properties": {},
- "id": "Empty"
- },
- "ReopenMatterRequest": {
- "description": "Reopen a matter by ID.",
- "type": "object",
- "properties": {},
- "id": "ReopenMatterRequest"
- },
- "CloseMatterRequest": {
- "description": "Close a matter by ID.",
- "type": "object",
- "properties": {},
- "id": "CloseMatterRequest"
- },
- "RemoveMatterPermissionsRequest": {
- "type": "object",
- "properties": {
- "accountId": {
- "description": "The account ID.",
- "type": "string"
- }
- },
- "id": "RemoveMatterPermissionsRequest",
- "description": "Remove an account as a matter collaborator."
+ "id": "UndeleteMatterRequest"
}
},
"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": "Vault",
@@ -376,27 +371,6 @@
"resources": {
"matters": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [
- "matterId"
- ],
- "parameters": {
- "matterId": {
- "description": "The matter ID",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/matters/{matterId}",
- "path": "v1/matters/{matterId}",
- "id": "vault.matters.delete",
- "description": "Deletes the specified matter. Returns matter with updated state."
- },
"list": {
"description": "Lists matters the user has access to.",
"response": {
@@ -405,26 +379,26 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "The pagination token as returned in the response.",
- "type": "string"
- },
"pageSize": {
- "format": "int32",
- "description": "The number of matters to return in the response.\nDefault and maximum are 100.",
"type": "integer",
- "location": "query"
+ "location": "query",
+ "format": "int32",
+ "description": "The number of matters to return in the response.\nDefault and maximum are 100."
},
"view": {
+ "description": "Specifies which parts of the matter to return in response.",
+ "type": "string",
"location": "query",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
- ],
- "description": "Specifies which parts of the matter to return in response.",
- "type": "string"
+ ]
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The pagination token as returned in the response."
}
},
"flatPath": "v1/matters",
@@ -432,6 +406,12 @@
"path": "v1/matters"
},
"addPermissions": {
+ "id": "vault.matters.addPermissions",
+ "path": "v1/matters/{matterId}:addPermissions",
+ "request": {
+ "$ref": "AddMatterPermissionsRequest"
+ },
+ "description": "Adds an account as a matter collaborator.",
"response": {
"$ref": "MatterPermission"
},
@@ -441,43 +421,30 @@
"httpMethod": "POST",
"parameters": {
"matterId": {
- "description": "The matter ID.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "The matter ID."
}
},
- "flatPath": "v1/matters/{matterId}:addPermissions",
- "id": "vault.matters.addPermissions",
- "path": "v1/matters/{matterId}:addPermissions",
- "description": "Adds an account as a matter collaborator.",
- "request": {
- "$ref": "AddMatterPermissionsRequest"
- }
+ "flatPath": "v1/matters/{matterId}:addPermissions"
},
"create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Matter"
- },
- "parameters": {},
- "flatPath": "v1/matters",
- "path": "v1/matters",
- "id": "vault.matters.create",
"description": "Creates a new matter. Returns created matter with default view.",
"request": {
"$ref": "Matter"
- }
+ },
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v1/matters",
+ "id": "vault.matters.create",
+ "path": "v1/matters"
},
"removePermissions": {
- "flatPath": "v1/matters/{matterId}:removePermissions",
- "id": "vault.matters.removePermissions",
- "path": "v1/matters/{matterId}:removePermissions",
- "request": {
- "$ref": "RemoveMatterPermissionsRequest"
- },
- "description": "Removes an account as a matter collaborator.",
"response": {
"$ref": "Empty"
},
@@ -492,64 +459,19 @@
"type": "string",
"required": true
}
- }
+ },
+ "flatPath": "v1/matters/{matterId}:removePermissions",
+ "id": "vault.matters.removePermissions",
+ "path": "v1/matters/{matterId}:removePermissions",
+ "request": {
+ "$ref": "RemoveMatterPermissionsRequest"
+ },
+ "description": "Removes an account as a matter collaborator."
},
"reopen": {
- "httpMethod": "POST",
- "parameterOrder": [
- "matterId"
- ],
"response": {
"$ref": "ReopenMatterResponse"
},
- "parameters": {
- "matterId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The matter ID."
- }
- },
- "flatPath": "v1/matters/{matterId}:reopen",
- "path": "v1/matters/{matterId}:reopen",
- "id": "vault.matters.reopen",
- "description": "Reopens the specified matter. Returns matter with updated state.",
- "request": {
- "$ref": "ReopenMatterRequest"
- }
- },
- "close": {
- "httpMethod": "POST",
- "parameterOrder": [
- "matterId"
- ],
- "response": {
- "$ref": "CloseMatterResponse"
- },
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/matters/{matterId}:close",
- "path": "v1/matters/{matterId}:close",
- "id": "vault.matters.close",
- "request": {
- "$ref": "CloseMatterRequest"
- },
- "description": "Closes the specified matter. Returns matter with updated state."
- },
- "undelete": {
- "request": {
- "$ref": "UndeleteMatterRequest"
- },
- "description": "Undeletes the specified matter. Returns matter with updated state.",
- "response": {
- "$ref": "Matter"
- },
"parameterOrder": [
"matterId"
],
@@ -562,9 +484,61 @@
"required": true
}
},
+ "flatPath": "v1/matters/{matterId}:reopen",
+ "id": "vault.matters.reopen",
+ "path": "v1/matters/{matterId}:reopen",
+ "description": "Reopens the specified matter. Returns matter with updated state.",
+ "request": {
+ "$ref": "ReopenMatterRequest"
+ }
+ },
+ "close": {
+ "flatPath": "v1/matters/{matterId}:close",
+ "path": "v1/matters/{matterId}:close",
+ "id": "vault.matters.close",
+ "request": {
+ "$ref": "CloseMatterRequest"
+ },
+ "description": "Closes the specified matter. Returns matter with updated state.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "matterId"
+ ],
+ "response": {
+ "$ref": "CloseMatterResponse"
+ },
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "undelete": {
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"flatPath": "v1/matters/{matterId}:undelete",
+ "path": "v1/matters/{matterId}:undelete",
"id": "vault.matters.undelete",
- "path": "v1/matters/{matterId}:undelete"
+ "description": "Undeletes the specified matter. Returns matter with updated state.",
+ "request": {
+ "$ref": "UndeleteMatterRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "matterId"
+ ],
+ "response": {
+ "$ref": "Matter"
+ }
},
"get": {
"description": "Gets the specified matter.",
@@ -576,21 +550,21 @@
],
"httpMethod": "GET",
"parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true
+ },
"view": {
- "description": "Specifies which parts of the Matter to return in the response.",
"type": "string",
"location": "query",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
- ]
- },
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "type": "string",
- "required": true
+ ],
+ "description": "Specifies which parts of the Matter to return in the response."
}
},
"flatPath": "v1/matters/{matterId}",
@@ -598,6 +572,13 @@
"path": "v1/matters/{matterId}"
},
"update": {
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "PUT",
"parameters": {
"matterId": {
"location": "path",
@@ -607,29 +588,70 @@
}
},
"flatPath": "v1/matters/{matterId}",
- "path": "v1/matters/{matterId}",
"id": "vault.matters.update",
- "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter.",
+ "path": "v1/matters/{matterId}",
"request": {
"$ref": "Matter"
},
- "httpMethod": "PUT",
+ "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter."
+ },
+ "delete": {
+ "flatPath": "v1/matters/{matterId}",
+ "path": "v1/matters/{matterId}",
+ "id": "vault.matters.delete",
+ "description": "Deletes the specified matter. Returns matter with updated state.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"matterId"
],
"response": {
"$ref": "Matter"
+ },
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
}
}
},
"resources": {
"holds": {
"methods": {
- "create": {
+ "update": {
+ "response": {
+ "$ref": "Hold"
+ },
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "holdId": {
+ "description": "The ID of the hold.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}",
+ "id": "vault.matters.holds.update",
+ "path": "v1/matters/{matterId}/holds/{holdId}",
"request": {
"$ref": "Hold"
},
- "description": "Creates a hold in the given matter.",
+ "description": "Updates the OU and/or query parameters of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored."
+ },
+ "create": {
"httpMethod": "POST",
"parameterOrder": [
"matterId"
@@ -647,69 +669,75 @@
},
"flatPath": "v1/matters/{matterId}/holds",
"path": "v1/matters/{matterId}/holds",
- "id": "vault.matters.holds.create"
+ "id": "vault.matters.holds.create",
+ "description": "Creates a hold in the given matter.",
+ "request": {
+ "$ref": "Hold"
+ }
},
"delete": {
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}",
+ "path": "v1/matters/{matterId}/holds/{holdId}",
+ "id": "vault.matters.holds.delete",
"description": "Removes a hold by ID. This will release any HeldAccounts on this Hold.",
"httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"matterId",
"holdId"
],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"holdId": {
- "location": "path",
"description": "The hold ID.",
"type": "string",
- "required": true
- },
- "matterId": {
- "description": "The matter ID.",
- "type": "string",
"required": true,
"location": "path"
+ },
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true
}
- },
- "flatPath": "v1/matters/{matterId}/holds/{holdId}",
- "path": "v1/matters/{matterId}/holds/{holdId}",
- "id": "vault.matters.holds.delete"
+ }
},
"list": {
- "path": "v1/matters/{matterId}/holds",
+ "flatPath": "v1/matters/{matterId}/holds",
"id": "vault.matters.holds.list",
+ "path": "v1/matters/{matterId}/holds",
"description": "Lists holds within a matter. An empty page token in ListHoldsResponse\ndenotes no more holds to list.",
- "httpMethod": "GET",
- "parameterOrder": [
- "matterId"
- ],
"response": {
"$ref": "ListHoldsResponse"
},
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "description": "The pagination token as returned in the response.\nAn empty token means start from the beginning.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The number of holds to return in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is the same as page_size = 100.",
- "type": "integer"
- },
"matterId": {
"description": "The matter ID.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The pagination token as returned in the response.\nAn empty token means start from the beginning.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The number of holds to return in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is the same as page_size = 100.",
+ "type": "integer",
+ "location": "query"
}
- },
- "flatPath": "v1/matters/{matterId}/holds"
+ }
},
"get": {
+ "id": "vault.matters.holds.get",
+ "path": "v1/matters/{matterId}/holds/{holdId}",
"description": "Gets a hold by ID.",
"response": {
"$ref": "Hold"
@@ -721,10 +749,10 @@
"httpMethod": "GET",
"parameters": {
"matterId": {
- "location": "path",
- "description": "The matter ID.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "description": "The matter ID."
},
"holdId": {
"description": "The hold ID.",
@@ -733,59 +761,91 @@
"location": "path"
}
},
- "flatPath": "v1/matters/{matterId}/holds/{holdId}",
- "id": "vault.matters.holds.get",
- "path": "v1/matters/{matterId}/holds/{holdId}"
- },
- "update": {
- "parameters": {
- "holdId": {
- "description": "The ID of the hold.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/matters/{matterId}/holds/{holdId}",
- "id": "vault.matters.holds.update",
- "path": "v1/matters/{matterId}/holds/{holdId}",
- "description": "Updates the OU and/or query parameters of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored.",
- "request": {
- "$ref": "Hold"
- },
- "response": {
- "$ref": "Hold"
- },
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "httpMethod": "PUT"
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}"
}
},
"resources": {
"accounts": {
"methods": {
+ "list": {
+ "response": {
+ "$ref": "ListHeldAccountsResponse"
+ },
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "holdId": {
+ "location": "path",
+ "description": "The hold ID.",
+ "type": "string",
+ "required": true
+ },
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
+ "id": "vault.matters.holds.accounts.list",
+ "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
+ "description": "Lists HeldAccounts for a hold. This will only list individually specified\nheld accounts. If the hold is on an OU, then use\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e\nto enumerate its members."
+ },
+ "create": {
+ "description": "Adds a HeldAccount to a hold. Accounts can only be added to a hold that\nhas no held_org_unit set. Attempting to add an account to an OU-based\nhold will result in an error.",
+ "request": {
+ "$ref": "HeldAccount"
+ },
+ "response": {
+ "$ref": "HeldAccount"
+ },
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "holdId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The hold ID."
+ }
+ },
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
+ "id": "vault.matters.holds.accounts.create",
+ "path": "v1/matters/{matterId}/holds/{holdId}/accounts"
+ },
"delete": {
"id": "vault.matters.holds.accounts.delete",
"path": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}",
"description": "Removes a HeldAccount from a hold. If this request leaves the hold with\nno held accounts, the hold will not apply to any accounts.",
+ "response": {
+ "$ref": "Empty"
+ },
"parameterOrder": [
"matterId",
"holdId",
"accountId"
],
- "response": {
- "$ref": "Empty"
- },
"httpMethod": "DELETE",
"parameters": {
+ "matterId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The matter ID."
+ },
"holdId": {
"description": "The hold ID.",
"type": "string",
@@ -797,74 +857,9 @@
"type": "string",
"required": true,
"location": "path"
- },
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "type": "string",
- "required": true
}
},
"flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}"
- },
- "list": {
- "response": {
- "$ref": "ListHeldAccountsResponse"
- },
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "matterId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The matter ID."
- },
- "holdId": {
- "location": "path",
- "description": "The hold ID.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "id": "vault.matters.holds.accounts.list",
- "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "description": "Lists HeldAccounts for a hold. This will only list individually specified\nheld accounts. If the hold is on an OU, then use\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e\nto enumerate its members."
- },
- "create": {
- "request": {
- "$ref": "HeldAccount"
- },
- "description": "Adds a HeldAccount to a hold. Accounts can only be added to a hold that\nhas no held_org_unit set. Attempting to add an account to an OU-based\nhold will result in an error.",
- "httpMethod": "POST",
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "response": {
- "$ref": "HeldAccount"
- },
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "type": "string",
- "required": true
- },
- "holdId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The hold ID."
- }
- },
- "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "id": "vault.matters.holds.accounts.create"
}
}
}
@@ -874,67 +869,36 @@
}
},
"parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
"location": "query"
},
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alt": {
+ "default": "json",
"enum": [
"json",
"media",
@@ -947,18 +911,54 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "description": "Data format for response."
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use 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"
},
- "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.",
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
}
- }
+ },
+ "version": "v1",
+ "baseUrl": "https://vault.googleapis.com/",
+ "servicePath": "",
+ "description": "",
+ "kind": "discovery#restDescription"
}
diff --git a/videointelligence/v1beta1/videointelligence-api.json b/videointelligence/v1beta1/videointelligence-api.json
index ee9f1d8..2cbe2b2 100644
--- a/videointelligence/v1beta1/videointelligence-api.json
+++ b/videointelligence/v1beta1/videointelligence-api.json
@@ -1,131 +1,11 @@
{
- "rootUrl": "https://videointelligence.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "videointelligence",
- "batchPath": "batch",
- "title": "Google Cloud Video Intelligence API",
- "ownerName": "Google",
- "resources": {
- "videos": {
- "methods": {
- "annotate": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "GoogleLongrunning_Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/videos:annotate",
- "path": "v1beta1/videos:annotate",
- "id": "videointelligence.videos.annotate",
- "description": "Performs asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results).",
- "request": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
- }
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://videointelligence.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Google Cloud Video Intelligence API.",
"servicePath": "",
+ "description": "Google Cloud Video Intelligence API.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20170807",
- "documentationLink": "https://cloud.google.com/video-intelligence/docs/",
"id": "videointelligence:v1beta1",
+ "documentationLink": "https://cloud.google.com/video-intelligence/docs/",
+ "revision": "20170807",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
@@ -152,8 +32,8 @@
]
},
"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"
+ "type": "string",
+ "description": "Optional location where the output (in JSON format) should be stored.\nCurrently, only [Google Cloud Storage](https://cloud.google.com/storage/)\nURIs are supported, which must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](/storage/docs/reference-uris)."
},
"videoContext": {
"$ref": "GoogleCloudVideointelligenceV1beta1_VideoContext",
@@ -168,17 +48,20 @@
"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"
+ "type": "string",
+ "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."
}
},
"id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest",
"description": "Video annotation request."
},
"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": {
"type": "string",
"enumDescriptions": [
@@ -198,53 +81,40 @@
"description": "Label level."
},
"confidence": {
- "type": "number",
"format": "float",
- "description": "Confidence that the label is accurate. Range: [0, 1]."
- },
- "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)."
+ "description": "Confidence that the label is accurate. Range: [0, 1].",
+ "type": "number"
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
+ "id": "GoogleCloudVideointelligenceV1beta1_LabelLocation",
+ "description": "Label location."
},
"GoogleCloudVideointelligenceV1beta1_VideoSegment": {
+ "description": "Video segment.",
"type": "object",
"properties": {
- "startTimeOffset": {
- "type": "string",
- "format": "int64",
- "description": "Start offset in microseconds (inclusive). Unset means 0."
- },
"endTimeOffset": {
"type": "string",
"format": "int64",
"description": "End offset in microseconds (inclusive). Unset means 0."
+ },
+ "startTimeOffset": {
+ "type": "string",
+ "format": "int64",
+ "description": "Start offset in microseconds (inclusive). Unset means 0."
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_VideoSegment",
- "description": "Video segment."
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
},
"GoogleCloudVideointelligenceV1_SafeSearchAnnotation": {
- "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame.",
"type": "object",
"properties": {
"time": {
+ "type": "string",
"format": "google-duration",
- "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the video frame for this annotation.",
- "type": "string"
+ "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the video frame for this annotation."
},
"adult": {
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
@@ -253,44 +123,7 @@
"LIKELY",
"VERY_LIKELY"
],
- "description": "Likelihood of adult content."
- }
- },
- "id": "GoogleCloudVideointelligenceV1_SafeSearchAnnotation"
- },
- "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation": {
- "type": "object",
- "properties": {
- "spoof": {
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood that an obvious modification was made to the original\nversion to make it appear funny or offensive."
- },
- "violent": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood of violent content.",
+ "description": "Likelihood of adult content.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
@@ -300,37 +133,15 @@
"Likely.",
"Very likely."
]
- },
- "medical": {
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood of medical content."
- },
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1_SafeSearchAnnotation",
+ "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame."
+ },
+ "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation": {
+ "type": "object",
+ "properties": {
"adult": {
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
@@ -339,7 +150,16 @@
"LIKELY",
"VERY_LIKELY"
],
- "description": "Likelihood of adult content."
+ "description": "Likelihood of adult content.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ]
},
"racy": {
"enum": [
@@ -365,6 +185,66 @@
"format": "int64",
"description": "Video time offset in microseconds.",
"type": "string"
+ },
+ "spoof": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood that an obvious modification was made to the original\nversion to make it appear funny or offensive."
+ },
+ "violent": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of violent content."
+ },
+ "medical": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of medical content.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ]
}
},
"id": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation",
@@ -389,9 +269,9 @@
"description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/)."
},
"progressPercent": {
- "type": "integer",
"format": "int32",
- "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed."
+ "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.",
+ "type": "integer"
}
},
"id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
@@ -401,63 +281,15 @@
"type": "object",
"properties": {
"annotationProgress": {
+ "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.",
"items": {
"$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress"
},
- "type": "array",
- "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`."
+ "type": "array"
}
},
"id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress"
},
- "GoogleCloudVideointelligenceV1_LabelLocation": {
- "type": "object",
- "properties": {
- "level": {
- "type": "string",
- "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."
- },
- "confidence": {
- "type": "number",
- "format": "float",
- "description": "Confidence that the label is accurate. Range: [0, 1]."
- },
- "segment": {
- "$ref": "GoogleCloudVideointelligenceV1_VideoSegment",
- "description": "Video segment. Unset for video-level labels.\nSet to a frame timestamp for frame-level labels.\nOtherwise, corresponds to one of `AnnotateSpec.segments`\n(if specified) or to shot boundaries (if requested)."
- }
- },
- "id": "GoogleCloudVideointelligenceV1_LabelLocation",
- "description": "Label location."
- },
- "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": {
- "type": "object",
- "properties": {
- "annotationProgress": {
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
- },
- "type": "array",
- "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`."
- }
- },
- "id": "GoogleCloudVideointelligenceV1_AnnotateVideoProgress",
- "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service."
- },
"GoogleCloudVideointelligenceV1_VideoAnnotationResults": {
"type": "object",
"properties": {
@@ -476,15 +308,15 @@
"type": "array"
},
"inputUri": {
- "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
- "type": "string"
+ "type": "string",
+ "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/)."
},
"labelAnnotations": {
- "description": "Label annotations. There is exactly one element for each unique label.",
"items": {
"$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation"
},
- "type": "array"
+ "type": "array",
+ "description": "Label annotations. There is exactly one element for each unique label."
},
"error": {
"$ref": "GoogleRpc_Status",
@@ -494,21 +326,58 @@
"id": "GoogleCloudVideointelligenceV1_VideoAnnotationResults",
"description": "Annotation results for a single video."
},
- "GoogleLongrunning_Operation": {
+ "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": {
+ "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
"type": "object",
"properties": {
- "metadata": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
+ "annotationProgress": {
+ "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
},
- "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": "array"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1_AnnotateVideoProgress"
+ },
+ "GoogleCloudVideointelligenceV1_LabelLocation": {
+ "type": "object",
+ "properties": {
+ "level": {
+ "enum": [
+ "LABEL_LEVEL_UNSPECIFIED",
+ "VIDEO_LEVEL",
+ "SEGMENT_LEVEL",
+ "SHOT_LEVEL",
+ "FRAME_LEVEL"
+ ],
+ "description": "Label level.",
+ "type": "string",
+ "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."
+ ]
},
- "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."
+ "confidence": {
+ "type": "number",
+ "format": "float",
+ "description": "Confidence that the label is accurate. Range: [0, 1]."
},
+ "segment": {
+ "$ref": "GoogleCloudVideointelligenceV1_VideoSegment",
+ "description": "Video segment. Unset for video-level labels.\nSet to a frame timestamp for frame-level labels.\nOtherwise, corresponds to one of `AnnotateSpec.segments`\n(if specified) or to shot boundaries (if requested)."
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1_LabelLocation",
+ "description": "Label location."
+ },
+ "GoogleLongrunning_Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
"response": {
"additionalProperties": {
"type": "any",
@@ -524,10 +393,21 @@
"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": {
+ "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": "GoogleLongrunning_Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
+ "id": "GoogleLongrunning_Operation"
},
"GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults": {
"description": "Annotation results for a single video.",
@@ -545,15 +425,15 @@
"type": "array"
},
"safeSearchAnnotations": {
- "description": "Safe search annotations.",
"items": {
"$ref": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation"
},
- "type": "array"
+ "type": "array",
+ "description": "Safe search annotations."
},
"inputUri": {
- "type": "string",
- "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/)."
+ "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
+ "type": "string"
},
"labelAnnotations": {
"description": "Label annotations. There is exactly one element for each unique label.",
@@ -602,6 +482,7 @@
"id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation"
},
"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": {
@@ -612,35 +493,26 @@
"description": "Annotation results for all videos specified in `AnnotateVideoRequest`."
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse",
- "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service."
- },
- "GoogleCloudVideointelligenceV1_LabelAnnotation": {
- "description": "Label annotation.",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "description": "Textual description, e.g. `Fixed-gear bicycle`."
- },
- "locations": {
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_LabelLocation"
- },
- "type": "array",
- "description": "Where the label was detected and with what confidence."
- },
- "languageCode": {
- "type": "string",
- "description": "Language code for `description` in BCP-47 format."
- }
- },
- "id": "GoogleCloudVideointelligenceV1_LabelAnnotation"
+ "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse"
},
"GoogleCloudVideointelligenceV1beta1_VideoContext": {
- "description": "Video context and/or feature-specific parameters.",
"type": "object",
"properties": {
+ "segments": {
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
+ },
+ "type": "array",
+ "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."
+ },
+ "labelDetectionModel": {
+ "type": "string",
+ "description": "Model to use for label detection.\nSupported values: \"latest\" and \"stable\" (the default)."
+ },
+ "shotChangeDetectionModel": {
+ "description": "Model to use for shot change detection.\nSupported values: \"latest\" and \"stable\" (the default).",
+ "type": "string"
+ },
"stationaryCamera": {
"type": "boolean",
"description": "Whether the video has been shot from a stationary (i.e. non-moving) camera.\nWhen set to true, might improve detection accuracy for moving objects."
@@ -664,32 +536,40 @@
"safeSearchDetectionModel": {
"type": "string",
"description": "Model to use for safe search detection.\nSupported values: \"latest\" and \"stable\" (the default)."
- },
- "segments": {
- "description": "Video segments to annotate. The segments may overlap and are not required\nto be contiguous or span the whole video. If unspecified, each video\nis treated as a single segment.",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
- },
- "type": "array"
- },
- "labelDetectionModel": {
- "description": "Model to use for label detection.\nSupported values: \"latest\" and \"stable\" (the default).",
- "type": "string"
- },
- "shotChangeDetectionModel": {
- "type": "string",
- "description": "Model to use for shot change detection.\nSupported values: \"latest\" and \"stable\" (the default)."
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_VideoContext"
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoContext",
+ "description": "Video context and/or feature-specific parameters."
+ },
+ "GoogleCloudVideointelligenceV1_LabelAnnotation": {
+ "type": "object",
+ "properties": {
+ "locations": {
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_LabelLocation"
+ },
+ "type": "array",
+ "description": "Where the label was detected and with what confidence."
+ },
+ "languageCode": {
+ "type": "string",
+ "description": "Language code for `description` in BCP-47 format."
+ },
+ "description": {
+ "description": "Textual description, e.g. `Fixed-gear bicycle`.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1_LabelAnnotation",
+ "description": "Label annotation."
},
"GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress": {
"type": "object",
"properties": {
"updateTime": {
- "type": "string",
"format": "google-datetime",
- "description": "Time of the most recent update."
+ "description": "Time of the most recent update.",
+ "type": "string"
},
"startTime": {
"format": "google-datetime",
@@ -713,6 +593,17 @@
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` 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": {
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
+ },
"code": {
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
@@ -721,17 +612,6 @@
"message": {
"type": "string",
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
}
},
"id": "GoogleRpc_Status"
@@ -740,9 +620,9 @@
"type": "object",
"properties": {
"endTime": {
- "type": "string",
"format": "google-duration",
- "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the end of the segment (inclusive)."
+ "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the end of the segment (inclusive).",
+ "type": "string"
},
"startTime": {
"type": "string",
@@ -754,11 +634,11 @@
"description": "Video segment."
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Cloud Video Intelligence",
"auth": {
"oauth2": {
@@ -768,5 +648,125 @@
}
}
}
- }
+ },
+ "rootUrl": "https://videointelligence.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "videointelligence",
+ "batchPath": "batch",
+ "title": "Google Cloud Video Intelligence API",
+ "ownerName": "Google",
+ "resources": {
+ "videos": {
+ "methods": {
+ "annotate": {
+ "flatPath": "v1beta1/videos:annotate",
+ "path": "v1beta1/videos:annotate",
+ "id": "videointelligence.videos.annotate",
+ "description": "Performs asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results).",
+ "request": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GoogleLongrunning_Operation"
+ },
+ "parameters": {},
+ "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": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://videointelligence.googleapis.com/"
}
diff --git a/vision/v1/vision-api.json b/vision/v1/vision-api.json
index 3c57387..e7b1062 100644
--- a/vision/v1/vision-api.json
+++ b/vision/v1/vision-api.json
@@ -1,485 +1,14 @@
{
+ "revision": "20170821",
+ "id": "vision:v1",
+ "documentationLink": "https://cloud.google.com/vision/",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "WebImage": {
- "description": "Metadata for online images.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The result image URL.",
- "type": "string"
- },
- "score": {
- "format": "float",
- "description": "(Deprecated) Overall relevancy score for the image.",
- "type": "number"
- }
- },
- "id": "WebImage"
- },
- "Word": {
- "description": "A word representation.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "TextProperty",
- "description": "Additional information detected for the word."
- },
- "boundingBox": {
- "$ref": "BoundingPoly",
- "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
- },
- "symbols": {
- "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.",
- "items": {
- "$ref": "Symbol"
- },
- "type": "array"
- }
- },
- "id": "Word"
- },
- "Image": {
- "description": "Client image to perform Google Cloud Vision API tasks over.",
- "type": "object",
- "properties": {
- "source": {
- "description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence and is\nused to perform the image annotation request.",
- "$ref": "ImageSource"
- },
- "content": {
- "format": "byte",
- "description": "Image content, represented as a stream of bytes.\nNote: as with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.",
- "type": "string"
- }
- },
- "id": "Image"
- },
- "Paragraph": {
- "description": "Structural unit of text representing a number of words in certain order.",
- "type": "object",
- "properties": {
- "property": {
- "description": "Additional information detected for the paragraph.",
- "$ref": "TextProperty"
- },
- "boundingBox": {
- "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
- "$ref": "BoundingPoly"
- },
- "words": {
- "description": "List of words in this paragraph.",
- "items": {
- "$ref": "Word"
- },
- "type": "array"
- }
- },
- "id": "Paragraph"
- },
- "FaceAnnotation": {
- "description": "A face annotation object contains the results of face detection.",
- "type": "object",
- "properties": {
- "tiltAngle": {
- "format": "float",
- "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
- "type": "number"
- },
- "fdBoundingPoly": {
- "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix.",
- "$ref": "BoundingPoly"
- },
- "angerLikelihood": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Anger likelihood.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- },
- "landmarks": {
- "description": "Detected face landmarks.",
- "items": {
- "$ref": "Landmark"
- },
- "type": "array"
- },
- "surpriseLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Surprise likelihood.",
- "type": "string"
- },
- "landmarkingConfidence": {
- "format": "float",
- "description": "Face landmarking confidence. Range [0, 1].",
- "type": "number"
- },
- "joyLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Joy likelihood.",
- "type": "string"
- },
- "detectionConfidence": {
- "format": "float",
- "description": "Detection confidence. Range [0, 1].",
- "type": "number"
- },
- "panAngle": {
- "format": "float",
- "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].",
- "type": "number"
- },
- "underExposedLikelihood": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Under-exposed likelihood.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- },
- "blurredLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Blurred likelihood.",
- "type": "string"
- },
- "headwearLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Headwear likelihood.",
- "type": "string"
- },
- "boundingPoly": {
- "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated.",
- "$ref": "BoundingPoly"
- },
- "rollAngle": {
- "format": "float",
- "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].",
- "type": "number"
- },
- "sorrowLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Sorrow likelihood.",
- "type": "string"
- }
- },
- "id": "FaceAnnotation"
- },
- "BatchAnnotateImagesRequest": {
- "properties": {
- "requests": {
- "description": "Individual image annotation requests for this batch.",
- "items": {
- "$ref": "AnnotateImageRequest"
- },
- "type": "array"
- }
- },
- "id": "BatchAnnotateImagesRequest",
- "description": "Multiple image annotation requests are batched into a single service call.",
- "type": "object"
- },
- "DetectedBreak": {
- "properties": {
- "type": {
- "enum": [
- "UNKNOWN",
- "SPACE",
- "SURE_SPACE",
- "EOL_SURE_SPACE",
- "HYPHEN",
- "LINE_BREAK"
- ],
- "description": "Detected break type.",
- "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.",
- "type": "boolean"
- }
- },
- "id": "DetectedBreak",
- "description": "Detected start or end of a structural component.",
- "type": "object"
- },
- "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).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "latLongRect": {
- "description": "lat/long rectangle that specifies the location of the image.",
- "$ref": "LatLongRect"
- },
- "cropHintsParams": {
- "$ref": "CropHintsParams",
- "description": "Parameters for crop hints annotation request."
- }
- },
- "id": "ImageContext"
- },
- "Page": {
- "description": "Detected page from OCR.",
- "type": "object",
- "properties": {
- "width": {
- "format": "int32",
- "description": "Page width in pixels.",
- "type": "integer"
- },
- "blocks": {
- "description": "List of blocks of text, images etc on this page.",
- "items": {
- "$ref": "Block"
- },
- "type": "array"
- },
- "property": {
- "$ref": "TextProperty",
- "description": "Additional information detected on the page."
- },
- "height": {
- "format": "int32",
- "description": "Page height in pixels.",
- "type": "integer"
- }
- },
- "id": "Page"
- },
- "AnnotateImageRequest": {
- "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
- "type": "object",
- "properties": {
- "features": {
- "description": "Requested features.",
- "items": {
- "$ref": "Feature"
- },
- "type": "array"
- },
- "image": {
- "$ref": "Image",
- "description": "The image to be processed."
- },
- "imageContext": {
- "$ref": "ImageContext",
- "description": "Additional context that may accompany the image."
- }
- },
- "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` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- }
- },
- "id": "Status"
- },
- "LatLongRect": {
- "description": "Rectangle determined by min and max `LatLng` pairs.",
- "type": "object",
- "properties": {
- "minLatLng": {
- "description": "Min lat/long pair.",
- "$ref": "LatLng"
- },
- "maxLatLng": {
- "$ref": "LatLng",
- "description": "Max lat/long pair."
- }
- },
- "id": "LatLongRect"
- },
- "Symbol": {
- "properties": {
- "property": {
- "$ref": "TextProperty",
- "description": "Additional information detected for the symbol."
- },
- "boundingBox": {
- "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
- "$ref": "BoundingPoly"
- },
- "text": {
- "description": "The actual UTF-8 representation of the symbol.",
- "type": "string"
- }
- },
- "id": "Symbol",
- "description": "A single symbol representation.",
- "type": "object"
- },
- "CropHintsAnnotation": {
- "description": "Set of crop hints that are used to generate new crops when serving images.",
- "type": "object",
- "properties": {
- "cropHints": {
- "description": "Crop hint results.",
- "items": {
- "$ref": "CropHint"
- },
- "type": "array"
- }
- },
- "id": "CropHintsAnnotation"
- },
- "LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
- "properties": {
- "latitude": {
- "format": "double",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "type": "number"
- },
- "longitude": {
- "format": "double",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "type": "number"
- }
- },
- "id": "LatLng"
- },
"Color": {
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
+ "type": "object",
"properties": {
- "red": {
- "format": "float",
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "type": "number"
- },
"alpha": {
"format": "float",
"description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
@@ -494,24 +23,18 @@
"format": "float",
"description": "The amount of green in the color as a value in the interval [0, 1].",
"type": "number"
+ },
+ "red": {
+ "format": "float",
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "type": "number"
}
},
- "id": "Color",
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "type": "object"
- },
- "ImageProperties": {
- "description": "Stores image properties, such as dominant colors.",
- "type": "object",
- "properties": {
- "dominantColors": {
- "description": "If present, dominant colors completed successfully.",
- "$ref": "DominantColorsAnnotation"
- }
- },
- "id": "ImageProperties"
+ "id": "Color"
},
"Feature": {
+ "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.",
+ "type": "object",
"properties": {
"maxResults": {
"format": "int32",
@@ -549,16 +72,25 @@
"type": "string"
}
},
- "id": "Feature",
- "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.",
- "type": "object"
+ "id": "Feature"
+ },
+ "ImageProperties": {
+ "description": "Stores image properties, such as dominant colors.",
+ "type": "object",
+ "properties": {
+ "dominantColors": {
+ "$ref": "DominantColorsAnnotation",
+ "description": "If present, dominant colors completed successfully."
+ }
+ },
+ "id": "ImageProperties"
},
"SafeSearchAnnotation": {
"description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).",
"type": "object",
"properties": {
- "spoof": {
- "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
+ "medical": {
+ "description": "Likelihood that this is a medical image.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
@@ -577,7 +109,7 @@
"VERY_LIKELY"
]
},
- "medical": {
+ "violence": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -594,19 +126,11 @@
"LIKELY",
"VERY_LIKELY"
],
- "description": "Likelihood that this is a medical image.",
- "type": "string"
- },
- "violence": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
"description": "Violence likelihood.",
+ "type": "string"
+ },
+ "adult": {
+ "description": "Represents the adult content likelihood for the image.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
@@ -615,10 +139,18 @@
"It is possible that the image belongs to the specified vertical.",
"It is likely that the image belongs to the specified vertical.",
"It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
]
},
- "adult": {
- "description": "Represents the adult content likelihood for the image.",
+ "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.",
@@ -706,6 +238,8 @@
"id": "Vertex"
},
"TextProperty": {
+ "description": "Additional information detected on the structural component.",
+ "type": "object",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
@@ -715,13 +249,11 @@
"type": "array"
},
"detectedBreak": {
- "$ref": "DetectedBreak",
- "description": "Detected start or end of a text segment."
+ "description": "Detected start or end of a text segment.",
+ "$ref": "DetectedBreak"
}
},
- "id": "TextProperty",
- "description": "Additional information detected on the structural component.",
- "type": "object"
+ "id": "TextProperty"
},
"BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
@@ -741,10 +273,6 @@
"description": "Entity deduced from similar images on the Internet.",
"type": "object",
"properties": {
- "entityId": {
- "description": "Opaque entity ID.",
- "type": "string"
- },
"description": {
"description": "Canonical description of the entity, in English.",
"type": "string"
@@ -753,6 +281,10 @@
"format": "float",
"description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.",
"type": "number"
+ },
+ "entityId": {
+ "description": "Opaque entity ID.",
+ "type": "string"
}
},
"id": "WebEntity"
@@ -761,6 +293,50 @@
"description": "Response to an image annotation request.",
"type": "object",
"properties": {
+ "textAnnotations": {
+ "description": "If present, text (OCR) detection has completed successfully.",
+ "items": {
+ "$ref": "EntityAnnotation"
+ },
+ "type": "array"
+ },
+ "faceAnnotations": {
+ "description": "If present, face detection has completed successfully.",
+ "items": {
+ "$ref": "FaceAnnotation"
+ },
+ "type": "array"
+ },
+ "imagePropertiesAnnotation": {
+ "$ref": "ImageProperties",
+ "description": "If present, image properties were extracted successfully."
+ },
+ "logoAnnotations": {
+ "description": "If present, logo detection has completed successfully.",
+ "items": {
+ "$ref": "EntityAnnotation"
+ },
+ "type": "array"
+ },
+ "cropHintsAnnotation": {
+ "$ref": "CropHintsAnnotation",
+ "description": "If present, crop hints have completed successfully."
+ },
+ "webDetection": {
+ "$ref": "WebDetection",
+ "description": "If present, web detection has completed successfully."
+ },
+ "labelAnnotations": {
+ "description": "If present, label detection has completed successfully.",
+ "items": {
+ "$ref": "EntityAnnotation"
+ },
+ "type": "array"
+ },
+ "safeSearchAnnotation": {
+ "$ref": "SafeSearchAnnotation",
+ "description": "If present, safe-search annotation has completed successfully."
+ },
"error": {
"$ref": "Status",
"description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set."
@@ -775,50 +351,6 @@
"$ref": "EntityAnnotation"
},
"type": "array"
- },
- "textAnnotations": {
- "description": "If present, text (OCR) detection has completed successfully.",
- "items": {
- "$ref": "EntityAnnotation"
- },
- "type": "array"
- },
- "imagePropertiesAnnotation": {
- "$ref": "ImageProperties",
- "description": "If present, image properties were extracted successfully."
- },
- "faceAnnotations": {
- "description": "If present, face detection has completed successfully.",
- "items": {
- "$ref": "FaceAnnotation"
- },
- "type": "array"
- },
- "logoAnnotations": {
- "description": "If present, logo detection has completed successfully.",
- "items": {
- "$ref": "EntityAnnotation"
- },
- "type": "array"
- },
- "webDetection": {
- "$ref": "WebDetection",
- "description": "If present, web detection has completed successfully."
- },
- "cropHintsAnnotation": {
- "$ref": "CropHintsAnnotation",
- "description": "If present, crop hints have completed successfully."
- },
- "safeSearchAnnotation": {
- "description": "If present, safe-search annotation has completed successfully.",
- "$ref": "SafeSearchAnnotation"
- },
- "labelAnnotations": {
- "description": "If present, label detection has completed successfully.",
- "items": {
- "$ref": "EntityAnnotation"
- },
- "type": "array"
}
},
"id": "AnnotateImageResponse"
@@ -839,12 +371,16 @@
"id": "CropHintsParams"
},
"Block": {
+ "description": "Logical element on the page.",
+ "type": "object",
"properties": {
"property": {
"description": "Additional information detected for the block.",
"$ref": "TextProperty"
},
"blockType": {
+ "description": "Detected block type (text, image etc) for this block.",
+ "type": "string",
"enumDescriptions": [
"Unknown block type.",
"Regular text block.",
@@ -860,9 +396,7 @@
"PICTURE",
"RULER",
"BARCODE"
- ],
- "description": "Detected block type (text, image etc) for this block.",
- "type": "string"
+ ]
},
"boundingBox": {
"description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * 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).",
@@ -876,9 +410,33 @@
"type": "array"
}
},
- "id": "Block",
- "description": "Logical element on the page.",
- "type": "object"
+ "id": "Block"
+ },
+ "LocationInfo": {
+ "description": "Detected entity location information.",
+ "type": "object",
+ "properties": {
+ "latLng": {
+ "$ref": "LatLng",
+ "description": "lat/long location coordinates."
+ }
+ },
+ "id": "LocationInfo"
+ },
+ "ImageSource": {
+ "description": "External image source (Google Cloud Storage image location).",
+ "type": "object",
+ "properties": {
+ "gcsImageUri": {
+ "description": "NOTE: For new code `image_uri` below is preferred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.",
+ "type": "string"
+ },
+ "imageUri": {
+ "description": "Image URI which supports:\n1) Google Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.",
+ "type": "string"
+ }
+ },
+ "id": "ImageSource"
},
"BatchAnnotateImagesResponse": {
"description": "Response to a batch image annotation request.",
@@ -895,21 +453,9 @@
"id": "BatchAnnotateImagesResponse"
},
"WebDetection": {
+ "description": "Relevant information for the image from the Internet.",
+ "type": "object",
"properties": {
- "visuallySimilarImages": {
- "description": "The visually similar image results.",
- "items": {
- "$ref": "WebImage"
- },
- "type": "array"
- },
- "partialMatchingImages": {
- "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.",
- "items": {
- "$ref": "WebImage"
- },
- "type": "array"
- },
"fullMatchingImages": {
"description": "Fully matching images from the Internet.\nCan include resized copies of the query image.",
"items": {
@@ -930,26 +476,23 @@
"$ref": "WebPage"
},
"type": "array"
- }
- },
- "id": "WebDetection",
- "description": "Relevant information for the image from the Internet.",
- "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"
+ "visuallySimilarImages": {
+ "description": "The visually similar image results.",
+ "items": {
+ "$ref": "WebImage"
+ },
+ "type": "array"
+ },
+ "partialMatchingImages": {
+ "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.",
+ "items": {
+ "$ref": "WebImage"
+ },
+ "type": "array"
}
},
- "id": "ImageSource"
+ "id": "WebDetection"
},
"Property": {
"description": "A `Property` consists of a user-supplied name/value pair.",
@@ -971,26 +514,10 @@
},
"id": "Property"
},
- "LocationInfo": {
- "description": "Detected entity location information.",
- "type": "object",
- "properties": {
- "latLng": {
- "$ref": "LatLng",
- "description": "lat/long location coordinates."
- }
- },
- "id": "LocationInfo"
- },
"Position": {
"description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
"type": "object",
"properties": {
- "y": {
- "format": "float",
- "description": "Y coordinate.",
- "type": "number"
- },
"z": {
"format": "float",
"description": "Z coordinate (or depth).",
@@ -1000,6 +527,11 @@
"format": "float",
"description": "X coordinate.",
"type": "number"
+ },
+ "y": {
+ "format": "float",
+ "description": "Y coordinate.",
+ "type": "number"
}
},
"id": "Position"
@@ -1024,19 +556,19 @@
"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": {
+ "format": "float",
+ "description": "Image-specific score for this color. Value in range [0, 1].",
+ "type": "number"
+ },
"pixelFraction": {
"format": "float",
"description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].",
"type": "number"
},
"color": {
- "description": "RGB components of the color.",
- "$ref": "Color"
- },
- "score": {
- "format": "float",
- "description": "Image-specific score for this color. Value in range [0, 1].",
- "type": "number"
+ "$ref": "Color",
+ "description": "RGB components of the color."
}
},
"id": "ColorInfo"
@@ -1045,35 +577,6 @@
"description": "Set of detected entity features.",
"type": "object",
"properties": {
- "confidence": {
- "format": "float",
- "description": "The accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].",
- "type": "number"
- },
- "locale": {
- "description": "The language code for the locale in which the entity textual\n`description` is expressed.",
- "type": "string"
- },
- "boundingPoly": {
- "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features.",
- "$ref": "BoundingPoly"
- },
- "topicality": {
- "format": "float",
- "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].",
- "type": "number"
- },
- "description": {
- "description": "Entity textual description, expressed in its `locale` language.",
- "type": "string"
- },
- "properties": {
- "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.",
- "items": {
- "$ref": "Property"
- },
- "type": "array"
- },
"score": {
"format": "float",
"description": "Overall score of the result. Range [0, 1].",
@@ -1089,11 +592,42 @@
"mid": {
"description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).",
"type": "string"
+ },
+ "confidence": {
+ "format": "float",
+ "description": "The accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].",
+ "type": "number"
+ },
+ "boundingPoly": {
+ "$ref": "BoundingPoly",
+ "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features."
+ },
+ "locale": {
+ "description": "The language code for the locale in which the entity textual\n`description` is expressed.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Entity textual description, expressed in its `locale` language.",
+ "type": "string"
+ },
+ "topicality": {
+ "format": "float",
+ "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].",
+ "type": "number"
+ },
+ "properties": {
+ "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.",
+ "items": {
+ "$ref": "Property"
+ },
+ "type": "array"
}
},
"id": "EntityAnnotation"
},
"CropHint": {
+ "description": "Single crop hint that is used to generate a new crop when serving an image.",
+ "type": "object",
"properties": {
"importanceFraction": {
"format": "float",
@@ -1110,54 +644,13 @@
"description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`."
}
},
- "id": "CropHint",
- "description": "Single crop hint that is used to generate a new crop when serving an image.",
- "type": "object"
+ "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": {
- "$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": [
@@ -1196,28 +689,539 @@
"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"
+ ]
+ },
+ "position": {
+ "description": "Face landmark position.",
+ "$ref": "Position"
+ }
+ },
+ "id": "Landmark"
+ },
+ "WebImage": {
+ "description": "Metadata for online images.",
+ "type": "object",
+ "properties": {
+ "score": {
+ "format": "float",
+ "description": "(Deprecated) Overall relevancy score for the image.",
+ "type": "number"
+ },
+ "url": {
+ "description": "The result image URL.",
+ "type": "string"
+ }
+ },
+ "id": "WebImage"
+ },
+ "Word": {
+ "description": "A word representation.",
+ "type": "object",
+ "properties": {
+ "symbols": {
+ "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.",
+ "items": {
+ "$ref": "Symbol"
+ },
+ "type": "array"
+ },
+ "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"
+ }
+ },
+ "id": "Word"
+ },
+ "Image": {
+ "description": "Client image to perform Google Cloud Vision API tasks over.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence and is\nused to perform the image annotation request.",
+ "$ref": "ImageSource"
+ },
+ "content": {
+ "format": "byte",
+ "description": "Image content, represented as a stream of bytes.\nNote: as with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.",
+ "type": "string"
+ }
+ },
+ "id": "Image"
+ },
+ "Paragraph": {
+ "description": "Structural unit of text representing a number of words in certain order.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "description": "Additional information detected for the paragraph.",
+ "$ref": "TextProperty"
+ },
+ "boundingBox": {
+ "$ref": "BoundingPoly",
+ "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
+ },
+ "words": {
+ "description": "List of words in this paragraph.",
+ "items": {
+ "$ref": "Word"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Paragraph"
+ },
+ "FaceAnnotation": {
+ "description": "A face annotation object contains the results of face detection.",
+ "type": "object",
+ "properties": {
+ "tiltAngle": {
+ "format": "float",
+ "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
+ "type": "number"
+ },
+ "fdBoundingPoly": {
+ "$ref": "BoundingPoly",
+ "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix."
+ },
+ "surpriseLikelihood": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Surprise likelihood.",
+ "type": "string"
+ },
+ "landmarks": {
+ "description": "Detected face landmarks.",
+ "items": {
+ "$ref": "Landmark"
+ },
+ "type": "array"
+ },
+ "angerLikelihood": {
+ "description": "Anger likelihood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ },
+ "joyLikelihood": {
+ "description": "Joy likelihood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ },
+ "landmarkingConfidence": {
+ "format": "float",
+ "description": "Face landmarking confidence. Range [0, 1].",
+ "type": "number"
+ },
+ "detectionConfidence": {
+ "format": "float",
+ "description": "Detection confidence. Range [0, 1].",
+ "type": "number"
+ },
+ "panAngle": {
+ "format": "float",
+ "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].",
+ "type": "number"
+ },
+ "underExposedLikelihood": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Under-exposed likelihood.",
+ "type": "string"
+ },
+ "blurredLikelihood": {
+ "description": "Blurred likelihood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ },
+ "headwearLikelihood": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Headwear likelihood.",
+ "type": "string"
+ },
+ "boundingPoly": {
+ "$ref": "BoundingPoly",
+ "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated."
+ },
+ "rollAngle": {
+ "format": "float",
+ "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].",
+ "type": "number"
+ },
+ "sorrowLikelihood": {
+ "description": "Sorrow likelihood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
]
}
},
- "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": "FaceAnnotation"
+ },
+ "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.",
+ "items": {
+ "$ref": "AnnotateImageRequest"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchAnnotateImagesRequest"
+ },
+ "DetectedBreak": {
+ "description": "Detected start or end of a structural component.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Detected break type.",
+ "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."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "SPACE",
+ "SURE_SPACE",
+ "EOL_SURE_SPACE",
+ "HYPHEN",
+ "LINE_BREAK"
+ ]
+ },
+ "isPrefix": {
+ "description": "True if break prepends the element.",
+ "type": "boolean"
+ }
+ },
+ "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).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "latLongRect": {
+ "description": "lat/long rectangle that specifies the location of the image.",
+ "$ref": "LatLongRect"
+ },
+ "cropHintsParams": {
+ "description": "Parameters for crop hints annotation request.",
+ "$ref": "CropHintsParams"
+ }
+ },
+ "id": "ImageContext"
+ },
+ "Page": {
+ "description": "Detected page from OCR.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "TextProperty",
+ "description": "Additional information detected on the page."
+ },
+ "height": {
+ "format": "int32",
+ "description": "Page height in pixels.",
+ "type": "integer"
+ },
+ "width": {
+ "format": "int32",
+ "description": "Page width in pixels.",
+ "type": "integer"
+ },
+ "blocks": {
+ "description": "List of blocks of text, images etc on this page.",
+ "items": {
+ "$ref": "Block"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Page"
+ },
+ "AnnotateImageRequest": {
+ "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
+ "type": "object",
+ "properties": {
+ "features": {
+ "description": "Requested features.",
+ "items": {
+ "$ref": "Feature"
+ },
+ "type": "array"
+ },
+ "image": {
+ "$ref": "Image",
+ "description": "The image to be processed."
+ },
+ "imageContext": {
+ "$ref": "ImageContext",
+ "description": "Additional context that may accompany the image."
+ }
+ },
+ "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` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Status"
+ },
+ "Symbol": {
+ "description": "A single symbol representation.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The actual UTF-8 representation of the symbol.",
+ "type": "string"
+ },
+ "property": {
+ "description": "Additional information detected for the symbol.",
+ "$ref": "TextProperty"
+ },
+ "boundingBox": {
+ "$ref": "BoundingPoly",
+ "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
+ }
+ },
+ "id": "Symbol"
+ },
+ "LatLongRect": {
+ "description": "Rectangle determined by min and max `LatLng` pairs.",
+ "type": "object",
+ "properties": {
+ "maxLatLng": {
+ "$ref": "LatLng",
+ "description": "Max lat/long pair."
+ },
+ "minLatLng": {
+ "description": "Min lat/long pair.",
+ "$ref": "LatLng"
+ }
+ },
+ "id": "LatLongRect"
+ },
+ "CropHintsAnnotation": {
+ "description": "Set of crop hints that are used to generate new crops when serving images.",
+ "type": "object",
+ "properties": {
+ "cropHints": {
+ "description": "Crop hint results.",
+ "items": {
+ "$ref": "CropHint"
+ },
+ "type": "array"
+ }
+ },
+ "id": "CropHintsAnnotation"
+ },
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object",
+ "properties": {
+ "latitude": {
+ "format": "double",
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "type": "number"
+ },
+ "longitude": {
+ "format": "double",
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "type": "number"
+ }
+ },
+ "id": "LatLng"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Vision",
"auth": {
"oauth2": {
"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-vision": {
"description": "Apply machine learning models to understand and label images"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -1237,23 +1241,88 @@
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
- "parameters": {},
"flatPath": "v1/images:annotate",
"path": "v1/images:annotate",
"id": "vision.images.annotate",
+ "description": "Run image detection and annotation for a batch of images.",
"request": {
"$ref": "BatchAnnotateImagesRequest"
- },
- "description": "Run image detection and annotation for a batch of images."
+ }
}
}
}
},
"parameters": {
+ "$.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": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -1274,81 +1343,12 @@
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
}
},
"version": "v1",
"baseUrl": "https://vision.googleapis.com/",
+ "servicePath": "",
"kind": "discovery#restDescription",
"description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
- "servicePath": "",
- "basePath": "",
- "id": "vision:v1",
- "revision": "20170821",
- "documentationLink": "https://cloud.google.com/vision/",
- "discoveryVersion": "v1"
+ "basePath": ""
}
diff --git a/youtubereporting/v1/youtubereporting-api.json b/youtubereporting/v1/youtubereporting-api.json
index 819ea45..1c65860 100644
--- a/youtubereporting/v1/youtubereporting-api.json
+++ b/youtubereporting/v1/youtubereporting-api.json
@@ -1,214 +1,57 @@
{
- "schemas": {
- "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": {
- "format": "google-datetime",
- "description": "The date/time when the job this report belongs to will expire/expired.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
- "type": "string"
- },
- "downloadUrl": {
- "description": "The URL from which the report can be downloaded (max. 1000 characters).",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The start of the time period that the report instance covers. The value is\ninclusive.",
- "type": "string"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "The date/time when this report was created.",
- "type": "string"
- }
- },
- "id": "Report"
- },
- "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"
- },
- "ListReportTypesResponse": {
- "description": "Response message for ReportingService.ListReportTypes.",
- "type": "object",
- "properties": {
- "reportTypes": {
- "description": "The list of report types.",
- "items": {
- "$ref": "ReportType"
+ "batchPath": "batch",
+ "revision": "20170823",
+ "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
+ "id": "youtubereporting:v1",
+ "title": "YouTube Reporting API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "resources": {
+ "reportTypes": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListReportTypesResponse"
},
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the\nListReportTypesRequest.page_token\nfield in the subsequent call to `ListReportTypes` method to retrieve the next\npage of results.",
- "type": "string"
- }
- },
- "id": "ListReportTypesResponse"
- },
- "ReportType": {
- "description": "A report type.",
- "type": "object",
- "properties": {
- "systemManaged": {
- "description": "True if this a system-managed report type; otherwise false. Reporting jobs\nfor system-managed report types are created automatically and can thus not\nbe used in the `CreateJob` method.",
- "type": "boolean"
- },
- "id": {
- "description": "The ID of the report type (max. 100 characters).",
- "type": "string"
- },
- "deprecateTime": {
- "format": "google-datetime",
- "description": "The date/time when this report type was/will be deprecated.",
- "type": "string"
- },
- "name": {
- "description": "The name of the report type (max. 100 characters).",
- "type": "string"
- }
- },
- "id": "ReportType"
- },
- "ListJobsResponse": {
- "description": "Response message for ReportingService.ListJobs.",
- "type": "object",
- "properties": {
- "jobs": {
- "description": "The list of jobs.",
- "items": {
- "$ref": "Job"
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "onBehalfOfContentOwner": {
+ "location": "query",
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string"
+ },
+ "includeSystemManaged": {
+ "description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageToken": {
+ "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"
+ }
},
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the\nListJobsRequest.page_token\nfield in the subsequent call to `ListJobs` method to retrieve the next\npage of results.",
- "type": "string"
- }
- },
- "id": "ListJobsResponse"
- },
- "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": {
- "format": "google-datetime",
- "description": "The creation date/time of the job.",
- "type": "string"
- },
- "reportTypeId": {
- "description": "The type of reports this job creates. Corresponds to the ID of a\nReportType.",
- "type": "string"
- },
- "expireTime": {
- "format": "google-datetime",
- "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
- "type": "string"
- },
- "name": {
- "description": "The name of the job (max. 100 characters).",
- "type": "string"
- }
- },
- "id": "Job"
- },
- "ListReportsResponse": {
- "description": "Response message for ReportingService.ListReports.",
- "type": "object",
- "properties": {
- "reports": {
- "description": "The list of report types.",
- "items": {
- "$ref": "Report"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.",
- "type": "string"
- }
- },
- "id": "ListReportsResponse"
- },
- "Media": {
- "description": "Media resource.",
- "type": "object",
- "properties": {
- "resourceName": {
- "description": "Name of the media resource.",
- "type": "string"
- }
- },
- "id": "Media"
- }
- },
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "version": "v1",
- "baseUrl": "https://youtubereporting.googleapis.com/",
- "canonicalName": "YouTube Reporting",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/yt-analytics.readonly": {
- "description": "View YouTube Analytics reports for your YouTube content"
- },
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly": {
- "description": "View monetary and non-monetary YouTube Analytics reports for your YouTube content"
+ "flatPath": "v1/reportTypes",
+ "path": "v1/reportTypes",
+ "id": "youtubereporting.reportTypes.list",
+ "description": "Lists report types."
}
}
- }
- },
- "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",
- "id": "youtubereporting:v1",
- "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
- "revision": "20170822",
- "title": "YouTube Reporting API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "resources": {
+ },
"media": {
"methods": {
"download": {
- "flatPath": "v1/media/{mediaId}",
- "path": "v1/media/{+resourceName}",
- "id": "youtubereporting.media.download",
"description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
"supportsMediaDownload": true,
"httpMethod": "GET",
@@ -230,16 +73,46 @@
"pattern": "^.+$",
"location": "path"
}
- }
+ },
+ "flatPath": "v1/media/{mediaId}",
+ "path": "v1/media/{+resourceName}",
+ "id": "youtubereporting.media.download"
}
}
},
"jobs": {
"methods": {
- "get": {
+ "delete": {
+ "description": "Deletes a job.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "The ID of the job to delete.",
+ "type": "string",
+ "required": true
+ },
+ "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",
+ "id": "youtubereporting.jobs.delete"
+ },
+ "get": {
"description": "Gets a job.",
"httpMethod": "GET",
"parameterOrder": [
@@ -248,23 +121,26 @@
"response": {
"$ref": "Job"
},
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "The ID of the job to retrieve.",
+ "type": "string",
+ "required": true
+ },
+ "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"
],
- "parameters": {
- "jobId": {
- "description": "The ID of the job to retrieve.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- }
- }
+ "flatPath": "v1/jobs/{jobId}",
+ "path": "v1/jobs/{jobId}",
+ "id": "youtubereporting.jobs.get"
},
"list": {
"flatPath": "v1/jobs",
@@ -309,11 +185,11 @@
"$ref": "Job"
},
"description": "Creates a job and returns it.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "Job"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
@@ -326,58 +202,37 @@
}
},
"flatPath": "v1/jobs",
- "path": "v1/jobs",
- "id": "youtubereporting.jobs.create"
- },
- "delete": {
- "description": "Deletes a job.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "jobId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "parameters": {
- "jobId": {
- "description": "The ID of the job to delete.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- }
- },
- "flatPath": "v1/jobs/{jobId}",
- "path": "v1/jobs/{jobId}",
- "id": "youtubereporting.jobs.delete"
+ "id": "youtubereporting.jobs.create",
+ "path": "v1/jobs"
}
},
"resources": {
"reports": {
"methods": {
"get": {
+ "flatPath": "v1/jobs/{jobId}/reports/{reportId}",
+ "path": "v1/jobs/{jobId}/reports/{reportId}",
+ "id": "youtubereporting.jobs.reports.get",
"description": "Gets the metadata of a specific report.",
- "response": {
- "$ref": "Report"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"jobId",
"reportId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Report"
+ },
"scopes": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
"parameters": {
+ "reportId": {
+ "description": "The ID of the report to retrieve.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
"jobId": {
"description": "The ID of the job.",
"type": "string",
@@ -385,20 +240,11 @@
"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"
- },
- "reportId": {
- "description": "The ID of the report to retrieve.",
"type": "string",
- "required": true,
- "location": "path"
+ "location": "query"
}
- },
- "flatPath": "v1/jobs/{jobId}/reports/{reportId}",
- "id": "youtubereporting.jobs.reports.get",
- "path": "v1/jobs/{jobId}/reports/{reportId}"
+ }
},
"list": {
"flatPath": "v1/jobs/{jobId}/reports",
@@ -413,34 +259,11 @@
],
"httpMethod": "GET",
"parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "onBehalfOfContentOwner": {
- "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": {
+ "createdAfter": {
"location": "query",
"format": "google-datetime",
- "description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.",
- "type": "string"
- },
- "jobId": {
- "location": "path",
- "description": "The ID of the job.",
- "type": "string",
- "required": true
- },
- "createdAfter": {
- "format": "google-datetime",
"description": "If set, only reports created after the specified date/time are returned.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"startTimeAtOrAfter": {
"format": "google-datetime",
@@ -449,9 +272,32 @@
"location": "query"
},
"pageToken": {
+ "location": "query",
"description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "onBehalfOfContentOwner": {
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
"type": "string",
"location": "query"
+ },
+ "startTimeBefore": {
+ "format": "google-datetime",
+ "description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "jobId": {
+ "description": "The ID of the job.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
"scopes": [
@@ -462,77 +308,50 @@
}
}
}
- },
- "reportTypes": {
- "methods": {
- "list": {
- "flatPath": "v1/reportTypes",
- "path": "v1/reportTypes",
- "id": "youtubereporting.reportTypes.list",
- "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": {
- "pageSize": {
- "format": "int32",
- "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "onBehalfOfContentOwner": {
- "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"
- },
- "includeSystemManaged": {
- "description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned.",
- "type": "boolean",
- "location": "query"
- },
- "pageToken": {
- "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"
- }
- }
- }
- }
}
},
"parameters": {
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
"pp": {
"location": "query",
"description": "Pretty-print response.",
"default": "true",
"type": "boolean"
},
- "oauth_token": {
+ "bearer_token": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "OAuth bearer token.",
"type": "string"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
@@ -540,16 +359,13 @@
"location": "query"
},
"uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
"location": "query",
- "description": "JSONP",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -558,11 +374,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",
@@ -571,27 +395,203 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "default": "json"
}
- }
+ },
+ "schemas": {
+ "Report": {
+ "description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
+ "type": "object",
+ "properties": {
+ "jobExpireTime": {
+ "format": "google-datetime",
+ "description": "The date/time when the job this report belongs to will expire/expired.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
+ "type": "string"
+ },
+ "downloadUrl": {
+ "description": "The URL from which the report can be downloaded (max. 1000 characters).",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start of the time period that the report instance covers. The value is\ninclusive.",
+ "type": "string"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The date/time when this report was created.",
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The ID of the job that created this report.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated ID of the report.",
+ "type": "string"
+ }
+ },
+ "id": "Report"
+ },
+ "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"
+ },
+ "ListReportTypesResponse": {
+ "description": "Response message for ReportingService.ListReportTypes.",
+ "type": "object",
+ "properties": {
+ "reportTypes": {
+ "description": "The list of report types.",
+ "items": {
+ "$ref": "ReportType"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListReportTypesRequest.page_token\nfield in the subsequent call to `ListReportTypes` method to retrieve the next\npage of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListReportTypesResponse"
+ },
+ "ReportType": {
+ "description": "A report type.",
+ "type": "object",
+ "properties": {
+ "deprecateTime": {
+ "format": "google-datetime",
+ "description": "The date/time when this report type was/will be deprecated.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the report type (max. 100 characters).",
+ "type": "string"
+ },
+ "systemManaged": {
+ "description": "True if this a system-managed report type; otherwise false. Reporting jobs\nfor system-managed report types are created automatically and can thus not\nbe used in the `CreateJob` method.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The ID of the report type (max. 100 characters).",
+ "type": "string"
+ }
+ },
+ "id": "ReportType"
+ },
+ "ListJobsResponse": {
+ "description": "Response message for ReportingService.ListJobs.",
+ "type": "object",
+ "properties": {
+ "jobs": {
+ "description": "The list of jobs.",
+ "items": {
+ "$ref": "Job"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListJobsRequest.page_token\nfield in the subsequent call to `ListJobs` method to retrieve the next\npage of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListJobsResponse"
+ },
+ "Job": {
+ "description": "A job creating reports of a specific type.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The creation date/time of the job.",
+ "type": "string"
+ },
+ "reportTypeId": {
+ "description": "The type of reports this job creates. Corresponds to the ID of a\nReportType.",
+ "type": "string"
+ },
+ "expireTime": {
+ "format": "google-datetime",
+ "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the job (max. 100 characters).",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated ID of the job (max. 40 characters).",
+ "type": "string"
+ },
+ "systemManaged": {
+ "description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.",
+ "type": "boolean"
+ }
+ },
+ "id": "Job"
+ },
+ "ListReportsResponse": {
+ "description": "Response message for ReportingService.ListReports.",
+ "type": "object",
+ "properties": {
+ "reports": {
+ "description": "The list of report types.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListReportsResponse"
+ },
+ "Media": {
+ "description": "Media resource.",
+ "type": "object",
+ "properties": {
+ "resourceName": {
+ "description": "Name of the media resource.",
+ "type": "string"
+ }
+ },
+ "id": "Media"
+ }
+ },
+ "protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "version": "v1",
+ "baseUrl": "https://youtubereporting.googleapis.com/",
+ "canonicalName": "YouTube Reporting",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/yt-analytics.readonly": {
+ "description": "View YouTube Analytics reports for your YouTube content"
+ },
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly": {
+ "description": "View monetary and non-monetary YouTube Analytics reports for your YouTube content"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.",
+ "servicePath": "",
+ "rootUrl": "https://youtubereporting.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "youtubereporting"
}
