| OLD | NEW |
|---|
| 1 { | 1 { |
| 2 "auth": { | 2 "auth": { |
| 3 "oauth2": { | 3 "oauth2": { |
| 4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 } | 7 } |
| 8 } | 8 } |
| 9 } | 9 } |
| 10 }, | 10 }, |
| 11 "basePath": "", | 11 "basePath": "", |
| 12 "baseUrl": "https://cloudbuild.googleapis.com/", | 12 "baseUrl": "https://cloudbuild.googleapis.com/", |
| 13 "batchPath": "batch", | 13 "batchPath": "batch", |
| 14 "canonicalName": "Cloud Build", | 14 "canonicalName": "Cloud Build", |
| 15 "description": "Builds container images in the cloud.", | 15 "description": "Builds container images in the cloud.", |
| 16 "discoveryVersion": "v1", | 16 "discoveryVersion": "v1", |
| 17 "documentationLink": "https://cloud.google.com/container-builder/docs/", | 17 "documentationLink": "https://cloud.google.com/container-builder/docs/", |
| 18 "icons": { | 18 "icons": { |
| 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 21 }, | 21 }, |
| 22 "id": "cloudbuild:v1", | 22 "id": "cloudbuild:v1", |
| 23 "kind": "discovery#restDescription", | 23 "kind": "discovery#restDescription", |
| 24 "name": "cloudbuild", | 24 "name": "cloudbuild", |
| 25 "ownerDomain": "google.com", | 25 "ownerDomain": "google.com", |
| 26 "ownerName": "Google", | 26 "ownerName": "Google", |
| 27 "parameters": { | 27 "parameters": { |
| 28 "pp": { |
| 29 "default": "true", |
| 30 "description": "Pretty-print response.", |
| 31 "location": "query", |
| 32 "type": "boolean" |
| 33 }, |
| 28 "bearer_token": { | 34 "bearer_token": { |
| 29 "description": "OAuth bearer token.", | 35 "description": "OAuth bearer token.", |
| 30 "location": "query", | 36 "location": "query", |
| 31 "type": "string" | 37 "type": "string" |
| 32 }, | 38 }, |
| 33 "oauth_token": { | 39 "oauth_token": { |
| 34 "description": "OAuth 2.0 token for the current user.", | 40 "description": "OAuth 2.0 token for the current user.", |
| 35 "location": "query", | 41 "location": "query", |
| 36 "type": "string" | 42 "type": "string" |
| 37 }, | 43 }, |
| (...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 83 "proto" | 89 "proto" |
| 84 ], | 90 ], |
| 85 "enumDescriptions": [ | 91 "enumDescriptions": [ |
| 86 "Responses with Content-Type of application/json", | 92 "Responses with Content-Type of application/json", |
| 87 "Media download with context-dependent Content-Type", | 93 "Media download with context-dependent Content-Type", |
| 88 "Responses with Content-Type of application/x-protobuf" | 94 "Responses with Content-Type of application/x-protobuf" |
| 89 ], | 95 ], |
| 90 "location": "query", | 96 "location": "query", |
| 91 "type": "string" | 97 "type": "string" |
| 92 }, | 98 }, |
| 99 "access_token": { |
| 100 "description": "OAuth access token.", |
| 101 "location": "query", |
| 102 "type": "string" |
| 103 }, |
| 93 "key": { | 104 "key": { |
| 94 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 105 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 95 "location": "query", | 106 "location": "query", |
| 96 "type": "string" | 107 "type": "string" |
| 97 }, | 108 }, |
| 98 "access_token": { | |
| 99 "description": "OAuth access token.", | |
| 100 "location": "query", | |
| 101 "type": "string" | |
| 102 }, | |
| 103 "quotaUser": { | 109 "quotaUser": { |
| 104 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 110 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 105 "location": "query", | 111 "location": "query", |
| 106 "type": "string" | 112 "type": "string" |
| 107 }, | |
| 108 "pp": { | |
| 109 "default": "true", | |
| 110 "description": "Pretty-print response.", | |
| 111 "location": "query", | |
| 112 "type": "boolean" | |
| 113 } | 113 } |
| 114 }, | 114 }, |
| 115 "protocol": "rest", | 115 "protocol": "rest", |
| 116 "resources": { | 116 "resources": { |
| 117 "projects": { | 117 "projects": { |
| 118 "resources": { | 118 "resources": { |
| 119 "triggers": { | 119 "builds": { |
| 120 "methods": { | 120 "methods": { |
| 121 "delete": { | 121 "cancel": { |
| 122 "description": "Deletes an BuildTrigger by its proje
ct ID and trigger ID.\n\nThis API is experimental.", | 122 "description": "Cancels a requested build in progres
s.", |
| 123 "httpMethod": "DELETE", | 123 "httpMethod": "POST", |
| 124 "id": "cloudbuild.projects.triggers.delete", | 124 "id": "cloudbuild.projects.builds.cancel", |
| 125 "parameterOrder": [ | 125 "parameterOrder": [ |
| 126 "projectId", | 126 "projectId", |
| 127 "triggerId" | 127 "id" |
| 128 ], | 128 ], |
| 129 "parameters": { | 129 "parameters": { |
| 130 "triggerId": { | 130 "projectId": { |
| 131 "description": "ID of the BuildTrigger to de
lete.", | 131 "description": "ID of the project.", |
| 132 "location": "path", | 132 "location": "path", |
| 133 "required": true, | 133 "required": true, |
| 134 "type": "string" | 134 "type": "string" |
| 135 }, | 135 }, |
| 136 "projectId": { | 136 "id": { |
| 137 "description": "ID of the project that owns
the trigger.", | 137 "description": "ID of the build.", |
| 138 "location": "path", | 138 "location": "path", |
| 139 "required": true, | 139 "required": true, |
| 140 "type": "string" | 140 "type": "string" |
| 141 } | 141 } |
| 142 }, | 142 }, |
| 143 "path": "v1/projects/{projectId}/triggers/{triggerId
}", | 143 "path": "v1/projects/{projectId}/builds/{id}:cancel"
, |
| 144 "request": { |
| 145 "$ref": "CancelBuildRequest" |
| 146 }, |
| 144 "response": { | 147 "response": { |
| 145 "$ref": "Empty" | 148 "$ref": "Build" |
| 146 }, | 149 }, |
| 147 "scopes": [ | 150 "scopes": [ |
| 148 "https://www.googleapis.com/auth/cloud-platform" | 151 "https://www.googleapis.com/auth/cloud-platform" |
| 149 ] | 152 ] |
| 150 }, | 153 }, |
| 151 "get": { | 154 "get": { |
| 152 "description": "Gets information about a BuildTrigge
r.\n\nThis API is experimental.", | 155 "description": "Returns information about a previous
ly requested build.\n\nThe Build that is returned includes its status (e.g., suc
cess or failure,\nor in-progress), and timing information.", |
| 153 "httpMethod": "GET", | 156 "httpMethod": "GET", |
| 154 "id": "cloudbuild.projects.triggers.get", | 157 "id": "cloudbuild.projects.builds.get", |
| 155 "parameterOrder": [ | 158 "parameterOrder": [ |
| 156 "projectId", | 159 "projectId", |
| 157 "triggerId" | 160 "id" |
| 158 ], | 161 ], |
| 159 "parameters": { | 162 "parameters": { |
| 160 "triggerId": { | 163 "projectId": { |
| 161 "description": "ID of the BuildTrigger to ge
t.", | 164 "description": "ID of the project.", |
| 162 "location": "path", | 165 "location": "path", |
| 163 "required": true, | 166 "required": true, |
| 164 "type": "string" | 167 "type": "string" |
| 165 }, | 168 }, |
| 166 "projectId": { | 169 "id": { |
| 167 "description": "ID of the project that owns
the trigger.", | 170 "description": "ID of the build.", |
| 168 "location": "path", | 171 "location": "path", |
| 169 "required": true, | 172 "required": true, |
| 170 "type": "string" | 173 "type": "string" |
| 171 } | 174 } |
| 172 }, | 175 }, |
| 173 "path": "v1/projects/{projectId}/triggers/{triggerId
}", | 176 "path": "v1/projects/{projectId}/builds/{id}", |
| 174 "response": { | 177 "response": { |
| 175 "$ref": "BuildTrigger" | 178 "$ref": "Build" |
| 176 }, | 179 }, |
| 177 "scopes": [ | 180 "scopes": [ |
| 178 "https://www.googleapis.com/auth/cloud-platform" | 181 "https://www.googleapis.com/auth/cloud-platform" |
| 179 ] | 182 ] |
| 180 }, | 183 }, |
| 181 "list": { | 184 "list": { |
| 182 "description": "Lists existing BuildTrigger.\n\nThis
API is experimental.", | 185 "description": "Lists previously requested builds.\n
\nPreviously requested builds may still be in-progress, or may have finished\nsu
ccessfully or unsuccessfully.", |
| 183 "httpMethod": "GET", | 186 "httpMethod": "GET", |
| 184 "id": "cloudbuild.projects.triggers.list", | 187 "id": "cloudbuild.projects.builds.list", |
| 185 "parameterOrder": [ | 188 "parameterOrder": [ |
| 186 "projectId" | 189 "projectId" |
| 187 ], | 190 ], |
| 188 "parameters": { | 191 "parameters": { |
| 192 "pageSize": { |
| 193 "description": "Number of results to return
in the list.", |
| 194 "format": "int32", |
| 195 "location": "query", |
| 196 "type": "integer" |
| 197 }, |
| 189 "projectId": { | 198 "projectId": { |
| 190 "description": "ID of the project for which
to list BuildTriggers.", | 199 "description": "ID of the project.", |
| 191 "location": "path", | |
| 192 "required": true, | |
| 193 "type": "string" | |
| 194 } | |
| 195 }, | |
| 196 "path": "v1/projects/{projectId}/triggers", | |
| 197 "response": { | |
| 198 "$ref": "ListBuildTriggersResponse" | |
| 199 }, | |
| 200 "scopes": [ | |
| 201 "https://www.googleapis.com/auth/cloud-platform" | |
| 202 ] | |
| 203 }, | |
| 204 "patch": { | |
| 205 "description": "Updates an BuildTrigger by its proje
ct ID and trigger ID.\n\nThis API is experimental.", | |
| 206 "httpMethod": "PATCH", | |
| 207 "id": "cloudbuild.projects.triggers.patch", | |
| 208 "parameterOrder": [ | |
| 209 "projectId", | |
| 210 "triggerId" | |
| 211 ], | |
| 212 "parameters": { | |
| 213 "triggerId": { | |
| 214 "description": "ID of the BuildTrigger to up
date.", | |
| 215 "location": "path", | 200 "location": "path", |
| 216 "required": true, | 201 "required": true, |
| 217 "type": "string" | 202 "type": "string" |
| 218 }, | 203 }, |
| 219 "projectId": { | 204 "filter": { |
| 220 "description": "ID of the project that owns
the trigger.", | 205 "description": "The raw filter text to const
rain the results.", |
| 221 "location": "path", | 206 "location": "query", |
| 222 "required": true, | 207 "type": "string" |
| 208 }, |
| 209 "pageToken": { |
| 210 "description": "Token to provide to skip to
a particular spot in the list.", |
| 211 "location": "query", |
| 223 "type": "string" | 212 "type": "string" |
| 224 } | 213 } |
| 225 }, | 214 }, |
| 226 "path": "v1/projects/{projectId}/triggers/{triggerId
}", | 215 "path": "v1/projects/{projectId}/builds", |
| 227 "request": { | |
| 228 "$ref": "BuildTrigger" | |
| 229 }, | |
| 230 "response": { | 216 "response": { |
| 231 "$ref": "BuildTrigger" | 217 "$ref": "ListBuildsResponse" |
| 232 }, | 218 }, |
| 233 "scopes": [ | 219 "scopes": [ |
| 234 "https://www.googleapis.com/auth/cloud-platform" | 220 "https://www.googleapis.com/auth/cloud-platform" |
| 235 ] | 221 ] |
| 236 }, | 222 }, |
| 237 "create": { | 223 "create": { |
| 238 "description": "Creates a new BuildTrigger.\n\nThis
API is experimental.", | 224 "description": "Starts a build with the specified co
nfiguration.\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).", |
| 239 "httpMethod": "POST", | 225 "httpMethod": "POST", |
| 240 "id": "cloudbuild.projects.triggers.create", | 226 "id": "cloudbuild.projects.builds.create", |
| 241 "parameterOrder": [ | 227 "parameterOrder": [ |
| 242 "projectId" | 228 "projectId" |
| 243 ], | 229 ], |
| 244 "parameters": { | 230 "parameters": { |
| 245 "projectId": { | 231 "projectId": { |
| 246 "description": "ID of the project for which
to configure automatic builds.", | 232 "description": "ID of the project.", |
| 247 "location": "path", | 233 "location": "path", |
| 248 "required": true, | 234 "required": true, |
| 249 "type": "string" | 235 "type": "string" |
| 250 } | 236 } |
| 251 }, | 237 }, |
| 252 "path": "v1/projects/{projectId}/triggers", | 238 "path": "v1/projects/{projectId}/builds", |
| 253 "request": { | 239 "request": { |
| 254 "$ref": "BuildTrigger" | 240 "$ref": "Build" |
| 255 }, | 241 }, |
| 256 "response": { | 242 "response": { |
| 257 "$ref": "BuildTrigger" | 243 "$ref": "Operation" |
| 258 }, | 244 }, |
| 259 "scopes": [ | 245 "scopes": [ |
| 260 "https://www.googleapis.com/auth/cloud-platform" | 246 "https://www.googleapis.com/auth/cloud-platform" |
| 261 ] | 247 ] |
| 262 } | 248 } |
| 263 } | 249 } |
| 264 }, | 250 }, |
| 265 "builds": { | 251 "triggers": { |
| 266 "methods": { | 252 "methods": { |
| 267 "create": { | 253 "delete": { |
| 268 "description": "Starts a build with the specified co
nfiguration.\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).", | 254 "description": "Deletes an BuildTrigger by its proje
ct ID and trigger ID.\n\nThis API is experimental.", |
| 269 "httpMethod": "POST", | 255 "httpMethod": "DELETE", |
| 270 "id": "cloudbuild.projects.builds.create", | 256 "id": "cloudbuild.projects.triggers.delete", |
| 271 "parameterOrder": [ | 257 "parameterOrder": [ |
| 272 "projectId" | 258 "projectId", |
| 259 "triggerId" |
| 273 ], | 260 ], |
| 274 "parameters": { | 261 "parameters": { |
| 262 "triggerId": { |
| 263 "description": "ID of the BuildTrigger to de
lete.", |
| 264 "location": "path", |
| 265 "required": true, |
| 266 "type": "string" |
| 267 }, |
| 275 "projectId": { | 268 "projectId": { |
| 276 "description": "ID of the project.", | 269 "description": "ID of the project that owns
the trigger.", |
| 277 "location": "path", | 270 "location": "path", |
| 278 "required": true, | 271 "required": true, |
| 279 "type": "string" | 272 "type": "string" |
| 280 } | 273 } |
| 281 }, | 274 }, |
| 282 "path": "v1/projects/{projectId}/builds", | 275 "path": "v1/projects/{projectId}/triggers/{triggerId
}", |
| 283 "request": { | |
| 284 "$ref": "Build" | |
| 285 }, | |
| 286 "response": { | 276 "response": { |
| 287 "$ref": "Operation" | 277 "$ref": "Empty" |
| 288 }, | |
| 289 "scopes": [ | |
| 290 "https://www.googleapis.com/auth/cloud-platform" | |
| 291 ] | |
| 292 }, | |
| 293 "cancel": { | |
| 294 "description": "Cancels a requested build in progres
s.", | |
| 295 "httpMethod": "POST", | |
| 296 "id": "cloudbuild.projects.builds.cancel", | |
| 297 "parameterOrder": [ | |
| 298 "projectId", | |
| 299 "id" | |
| 300 ], | |
| 301 "parameters": { | |
| 302 "projectId": { | |
| 303 "description": "ID of the project.", | |
| 304 "location": "path", | |
| 305 "required": true, | |
| 306 "type": "string" | |
| 307 }, | |
| 308 "id": { | |
| 309 "description": "ID of the build.", | |
| 310 "location": "path", | |
| 311 "required": true, | |
| 312 "type": "string" | |
| 313 } | |
| 314 }, | |
| 315 "path": "v1/projects/{projectId}/builds/{id}:cancel"
, | |
| 316 "request": { | |
| 317 "$ref": "CancelBuildRequest" | |
| 318 }, | |
| 319 "response": { | |
| 320 "$ref": "Build" | |
| 321 }, | 278 }, |
| 322 "scopes": [ | 279 "scopes": [ |
| 323 "https://www.googleapis.com/auth/cloud-platform" | 280 "https://www.googleapis.com/auth/cloud-platform" |
| 324 ] | 281 ] |
| 325 }, | 282 }, |
| 326 "get": { | 283 "get": { |
| 327 "description": "Returns information about a previous
ly requested build.\n\nThe Build that is returned includes its status (e.g., suc
cess or failure,\nor in-progress), and timing information.", | 284 "description": "Gets information about a BuildTrigge
r.\n\nThis API is experimental.", |
| 328 "httpMethod": "GET", | 285 "httpMethod": "GET", |
| 329 "id": "cloudbuild.projects.builds.get", | 286 "id": "cloudbuild.projects.triggers.get", |
| 330 "parameterOrder": [ | 287 "parameterOrder": [ |
| 331 "projectId", | 288 "projectId", |
| 332 "id" | 289 "triggerId" |
| 333 ], | 290 ], |
| 334 "parameters": { | 291 "parameters": { |
| 335 "id": { | 292 "triggerId": { |
| 336 "description": "ID of the build.", | 293 "description": "ID of the BuildTrigger to ge
t.", |
| 337 "location": "path", | 294 "location": "path", |
| 338 "required": true, | 295 "required": true, |
| 339 "type": "string" | 296 "type": "string" |
| 340 }, | 297 }, |
| 341 "projectId": { | 298 "projectId": { |
| 342 "description": "ID of the project.", | 299 "description": "ID of the project that owns
the trigger.", |
| 343 "location": "path", | 300 "location": "path", |
| 344 "required": true, | 301 "required": true, |
| 345 "type": "string" | 302 "type": "string" |
| 346 } | 303 } |
| 347 }, | 304 }, |
| 348 "path": "v1/projects/{projectId}/builds/{id}", | 305 "path": "v1/projects/{projectId}/triggers/{triggerId
}", |
| 349 "response": { | 306 "response": { |
| 350 "$ref": "Build" | 307 "$ref": "BuildTrigger" |
| 351 }, | 308 }, |
| 352 "scopes": [ | 309 "scopes": [ |
| 353 "https://www.googleapis.com/auth/cloud-platform" | 310 "https://www.googleapis.com/auth/cloud-platform" |
| 354 ] | 311 ] |
| 355 }, | 312 }, |
| 356 "list": { | 313 "list": { |
| 357 "description": "Lists previously requested builds.\n
\nPreviously requested builds may still be in-progress, or may have finished\nsu
ccessfully or unsuccessfully.", | 314 "description": "Lists existing BuildTrigger.\n\nThis
API is experimental.", |
| 358 "httpMethod": "GET", | 315 "httpMethod": "GET", |
| 359 "id": "cloudbuild.projects.builds.list", | 316 "id": "cloudbuild.projects.triggers.list", |
| 360 "parameterOrder": [ | 317 "parameterOrder": [ |
| 361 "projectId" | 318 "projectId" |
| 362 ], | 319 ], |
| 363 "parameters": { | 320 "parameters": { |
| 364 "pageToken": { | 321 "projectId": { |
| 365 "description": "Token to provide to skip to
a particular spot in the list.", | 322 "description": "ID of the project for which
to list BuildTriggers.", |
| 366 "location": "query", | 323 "location": "path", |
| 324 "required": true, |
| 367 "type": "string" | 325 "type": "string" |
| 368 }, | 326 } |
| 369 "pageSize": { | 327 }, |
| 370 "description": "Number of results to return
in the list.", | 328 "path": "v1/projects/{projectId}/triggers", |
| 371 "format": "int32", | 329 "response": { |
| 372 "location": "query", | 330 "$ref": "ListBuildTriggersResponse" |
| 373 "type": "integer" | 331 }, |
| 374 }, | 332 "scopes": [ |
| 375 "projectId": { | 333 "https://www.googleapis.com/auth/cloud-platform" |
| 376 "description": "ID of the project.", | 334 ] |
| 335 }, |
| 336 "patch": { |
| 337 "description": "Updates an BuildTrigger by its proje
ct ID and trigger ID.\n\nThis API is experimental.", |
| 338 "httpMethod": "PATCH", |
| 339 "id": "cloudbuild.projects.triggers.patch", |
| 340 "parameterOrder": [ |
| 341 "projectId", |
| 342 "triggerId" |
| 343 ], |
| 344 "parameters": { |
| 345 "triggerId": { |
| 346 "description": "ID of the BuildTrigger to up
date.", |
| 377 "location": "path", | 347 "location": "path", |
| 378 "required": true, | 348 "required": true, |
| 379 "type": "string" | 349 "type": "string" |
| 380 }, | 350 }, |
| 381 "filter": { | 351 "projectId": { |
| 382 "description": "The raw filter text to const
rain the results.", | 352 "description": "ID of the project that owns
the trigger.", |
| 383 "location": "query", | 353 "location": "path", |
| 354 "required": true, |
| 384 "type": "string" | 355 "type": "string" |
| 385 } | 356 } |
| 386 }, | 357 }, |
| 387 "path": "v1/projects/{projectId}/builds", | 358 "path": "v1/projects/{projectId}/triggers/{triggerId
}", |
| 359 "request": { |
| 360 "$ref": "BuildTrigger" |
| 361 }, |
| 388 "response": { | 362 "response": { |
| 389 "$ref": "ListBuildsResponse" | 363 "$ref": "BuildTrigger" |
| 364 }, |
| 365 "scopes": [ |
| 366 "https://www.googleapis.com/auth/cloud-platform" |
| 367 ] |
| 368 }, |
| 369 "create": { |
| 370 "description": "Creates a new BuildTrigger.\n\nThis
API is experimental.", |
| 371 "httpMethod": "POST", |
| 372 "id": "cloudbuild.projects.triggers.create", |
| 373 "parameterOrder": [ |
| 374 "projectId" |
| 375 ], |
| 376 "parameters": { |
| 377 "projectId": { |
| 378 "description": "ID of the project for which
to configure automatic builds.", |
| 379 "location": "path", |
| 380 "required": true, |
| 381 "type": "string" |
| 382 } |
| 383 }, |
| 384 "path": "v1/projects/{projectId}/triggers", |
| 385 "request": { |
| 386 "$ref": "BuildTrigger" |
| 387 }, |
| 388 "response": { |
| 389 "$ref": "BuildTrigger" |
| 390 }, | 390 }, |
| 391 "scopes": [ | 391 "scopes": [ |
| 392 "https://www.googleapis.com/auth/cloud-platform" | 392 "https://www.googleapis.com/auth/cloud-platform" |
| 393 ] | 393 ] |
| 394 } | 394 } |
| 395 } | 395 } |
| 396 } | 396 } |
| 397 } | 397 } |
| 398 }, | 398 }, |
| 399 "operations": { | 399 "operations": { |
| (...skipping 26 matching lines...) Expand all Loading... |
| 426 ] | 426 ] |
| 427 }, | 427 }, |
| 428 "list": { | 428 "list": { |
| 429 "description": "Lists operations that match the specified fi
lter in the request. If the\nserver doesn't support this method, it returns `UNI
MPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override t
he binding\nto use different resource name schemes, such as `users/*/operations`
.", | 429 "description": "Lists operations that match the specified fi
lter in the request. If the\nserver doesn't support this method, it returns `UNI
MPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override t
he binding\nto use different resource name schemes, such as `users/*/operations`
.", |
| 430 "httpMethod": "GET", | 430 "httpMethod": "GET", |
| 431 "id": "cloudbuild.operations.list", | 431 "id": "cloudbuild.operations.list", |
| 432 "parameterOrder": [ | 432 "parameterOrder": [ |
| 433 "name" | 433 "name" |
| 434 ], | 434 ], |
| 435 "parameters": { | 435 "parameters": { |
| 436 "filter": { |
| 437 "description": "The standard list filter.", |
| 438 "location": "query", |
| 439 "type": "string" |
| 440 }, |
| 436 "name": { | 441 "name": { |
| 437 "description": "The name of the operation collection
.", | 442 "description": "The name of the operation collection
.", |
| 438 "location": "path", | 443 "location": "path", |
| 439 "pattern": "^operations$", | 444 "pattern": "^operations$", |
| 440 "required": true, | 445 "required": true, |
| 441 "type": "string" | 446 "type": "string" |
| 442 }, | 447 }, |
| 443 "pageToken": { | 448 "pageToken": { |
| 444 "description": "The standard list page token.", | 449 "description": "The standard list page token.", |
| 445 "location": "query", | 450 "location": "query", |
| 446 "type": "string" | 451 "type": "string" |
| 447 }, | 452 }, |
| 448 "pageSize": { | 453 "pageSize": { |
| 449 "description": "The standard list page size.", | 454 "description": "The standard list page size.", |
| 450 "format": "int32", | 455 "format": "int32", |
| 451 "location": "query", | 456 "location": "query", |
| 452 "type": "integer" | 457 "type": "integer" |
| 453 }, | |
| 454 "filter": { | |
| 455 "description": "The standard list filter.", | |
| 456 "location": "query", | |
| 457 "type": "string" | |
| 458 } | 458 } |
| 459 }, | 459 }, |
| 460 "path": "v1/{+name}", | 460 "path": "v1/{+name}", |
| 461 "response": { | 461 "response": { |
| 462 "$ref": "ListOperationsResponse" | 462 "$ref": "ListOperationsResponse" |
| 463 }, | 463 }, |
| 464 "scopes": [ | 464 "scopes": [ |
| 465 "https://www.googleapis.com/auth/cloud-platform" | 465 "https://www.googleapis.com/auth/cloud-platform" |
| 466 ] | 466 ] |
| 467 }, | 467 }, |
| (...skipping 17 matching lines...) Expand all Loading... |
| 485 "response": { | 485 "response": { |
| 486 "$ref": "Operation" | 486 "$ref": "Operation" |
| 487 }, | 487 }, |
| 488 "scopes": [ | 488 "scopes": [ |
| 489 "https://www.googleapis.com/auth/cloud-platform" | 489 "https://www.googleapis.com/auth/cloud-platform" |
| 490 ] | 490 ] |
| 491 } | 491 } |
| 492 } | 492 } |
| 493 } | 493 } |
| 494 }, | 494 }, |
| 495 "revision": "20170302", | 495 "revision": "20170323", |
| 496 "rootUrl": "https://cloudbuild.googleapis.com/", | 496 "rootUrl": "https://cloudbuild.googleapis.com/", |
| 497 "schemas": { | 497 "schemas": { |
| 498 "BuildOperationMetadata": { | |
| 499 "description": "Metadata for build operations.", | |
| 500 "id": "BuildOperationMetadata", | |
| 501 "properties": { | |
| 502 "build": { | |
| 503 "$ref": "Build", | |
| 504 "description": "The build that the operation is tracking." | |
| 505 } | |
| 506 }, | |
| 507 "type": "object" | |
| 508 }, | |
| 509 "SourceProvenance": { | |
| 510 "description": "Provenance of the source. Ways to find the original
source, or verify that\nsome source was used for this build.", | |
| 511 "id": "SourceProvenance", | |
| 512 "properties": { | |
| 513 "fileHashes": { | |
| 514 "additionalProperties": { | |
| 515 "$ref": "FileHashes" | |
| 516 }, | |
| 517 "description": "Hash(es) of the build source, which can be u
sed to verify that the original\nsource integrity was maintained in the build. N
ote that FileHashes will\nonly be populated if BuildOptions has requested a Sour
ceProvenanceHash.\n\nThe keys to this map are file paths used as build source an
d the values\ncontain the hash values for those files.\n\nIf the build source ca
me in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will b
e for the single path to that file.\n@OutputOnly", | |
| 518 "type": "object" | |
| 519 }, | |
| 520 "resolvedRepoSource": { | |
| 521 "$ref": "RepoSource", | |
| 522 "description": "A copy of the build's source.repo_source, if
exists, with any\nrevisions resolved." | |
| 523 }, | |
| 524 "resolvedStorageSource": { | |
| 525 "$ref": "StorageSource", | |
| 526 "description": "A copy of the build's source.storage_source,
if exists, with any\ngenerations resolved." | |
| 527 } | |
| 528 }, | |
| 529 "type": "object" | |
| 530 }, | |
| 531 "CancelOperationRequest": { | |
| 532 "description": "The request message for Operations.CancelOperation."
, | |
| 533 "id": "CancelOperationRequest", | |
| 534 "properties": {}, | |
| 535 "type": "object" | |
| 536 }, | |
| 537 "Operation": { | |
| 538 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", | |
| 539 "id": "Operation", | |
| 540 "properties": { | |
| 541 "response": { | |
| 542 "additionalProperties": { | |
| 543 "description": "Properties of the object. Contains field
@type with type URL.", | |
| 544 "type": "any" | |
| 545 }, | |
| 546 "description": "The normal response of the operation in case
of success. If the original\nmethod returns no data on success, such as `Delet
e`, the response is\n`google.protobuf.Empty`. If the original method is standar
d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet
hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi
nal method name. For example, if the original method name\nis `TakeSnapshot()`,
the inferred response type is\n`TakeSnapshotResponse`.", | |
| 547 "type": "object" | |
| 548 }, | |
| 549 "name": { | |
| 550 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", | |
| 551 "type": "string" | |
| 552 }, | |
| 553 "error": { | |
| 554 "$ref": "Status", | |
| 555 "description": "The error result of the operation in case of
failure or cancellation." | |
| 556 }, | |
| 557 "metadata": { | |
| 558 "additionalProperties": { | |
| 559 "description": "Properties of the object. Contains field
@type with type URL.", | |
| 560 "type": "any" | |
| 561 }, | |
| 562 "description": "Service-specific metadata associated with th
e operation. It typically\ncontains progress information and common metadata su
ch as create time.\nSome services might not provide such metadata. Any method t
hat returns a\nlong-running operation should document the metadata type, if any.
", | |
| 563 "type": "object" | |
| 564 }, | |
| 565 "done": { | |
| 566 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf true, the operation is completed, and either `erro
r` or `response` is\navailable.", | |
| 567 "type": "boolean" | |
| 568 } | |
| 569 }, | |
| 570 "type": "object" | |
| 571 }, | |
| 572 "ListBuildTriggersResponse": { | |
| 573 "description": "Response containing existing BuildTriggers.", | |
| 574 "id": "ListBuildTriggersResponse", | |
| 575 "properties": { | |
| 576 "triggers": { | |
| 577 "description": "BuildTriggers for the project, sorted by cre
ate_time descending.", | |
| 578 "items": { | |
| 579 "$ref": "BuildTrigger" | |
| 580 }, | |
| 581 "type": "array" | |
| 582 } | |
| 583 }, | |
| 584 "type": "object" | |
| 585 }, | |
| 586 "BuiltImage": { | |
| 587 "description": "BuiltImage describes an image built by the pipeline.
", | |
| 588 "id": "BuiltImage", | |
| 589 "properties": { | |
| 590 "name": { | |
| 591 "description": "Name used to push the container image to Goo
gle Container Registry, as\npresented to `docker push`.", | |
| 592 "type": "string" | |
| 593 }, | |
| 594 "digest": { | |
| 595 "description": "Docker Registry 2.0 digest.", | |
| 596 "type": "string" | |
| 597 } | |
| 598 }, | |
| 599 "type": "object" | |
| 600 }, | |
| 601 "Hash": { | |
| 602 "description": "Container message for hash values.", | |
| 603 "id": "Hash", | |
| 604 "properties": { | |
| 605 "value": { | |
| 606 "description": "The hash value.", | |
| 607 "format": "byte", | |
| 608 "type": "string" | |
| 609 }, | |
| 610 "type": { | |
| 611 "description": "The type of hash that was performed.", | |
| 612 "enum": [ | |
| 613 "NONE", | |
| 614 "SHA256" | |
| 615 ], | |
| 616 "enumDescriptions": [ | |
| 617 "No hash requested.", | |
| 618 "Use a sha256 hash." | |
| 619 ], | |
| 620 "type": "string" | |
| 621 } | |
| 622 }, | |
| 623 "type": "object" | |
| 624 }, | |
| 625 "RepoSource": { | |
| 626 "description": "RepoSource describes the location of the source in a
Google Cloud Source\nRepository.", | |
| 627 "id": "RepoSource", | |
| 628 "properties": { | |
| 629 "tagName": { | |
| 630 "description": "Name of the tag to build.", | |
| 631 "type": "string" | |
| 632 }, | |
| 633 "commitSha": { | |
| 634 "description": "Explicit commit SHA to build.", | |
| 635 "type": "string" | |
| 636 }, | |
| 637 "projectId": { | |
| 638 "description": "ID of the project that owns the repo. If omi
tted, the project ID requesting\nthe build is assumed.", | |
| 639 "type": "string" | |
| 640 }, | |
| 641 "repoName": { | |
| 642 "description": "Name of the repo. If omitted, the name \"def
ault\" is assumed.", | |
| 643 "type": "string" | |
| 644 }, | |
| 645 "branchName": { | |
| 646 "description": "Name of the branch to build.", | |
| 647 "type": "string" | |
| 648 } | |
| 649 }, | |
| 650 "type": "object" | |
| 651 }, | |
| 652 "BuildStep": { | |
| 653 "description": "BuildStep describes a step to perform in the build p
ipeline.", | |
| 654 "id": "BuildStep", | |
| 655 "properties": { | |
| 656 "entrypoint": { | |
| 657 "description": "Optional entrypoint to be used instead of th
e build step image's default\nIf unset, the image's default will be used.", | |
| 658 "type": "string" | |
| 659 }, | |
| 660 "id": { | |
| 661 "description": "Optional unique identifier for this build st
ep, used in wait_for to\nreference this build step as a dependency.", | |
| 662 "type": "string" | |
| 663 }, | |
| 664 "dir": { | |
| 665 "description": "Working directory (relative to project sourc
e root) to use when running\nthis operation's container.", | |
| 666 "type": "string" | |
| 667 }, | |
| 668 "waitFor": { | |
| 669 "description": "The ID(s) of the step(s) that this build ste
p 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\nst
art when all previous build steps in the Build.Steps list have completed\nsucces
sfully.", | |
| 670 "items": { | |
| 671 "type": "string" | |
| 672 }, | |
| 673 "type": "array" | |
| 674 }, | |
| 675 "env": { | |
| 676 "description": "A list of environment variable definitions t
o 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\".", | |
| 677 "items": { | |
| 678 "type": "string" | |
| 679 }, | |
| 680 "type": "array" | |
| 681 }, | |
| 682 "args": { | |
| 683 "description": "A list of arguments that will be presented t
o 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.", | |
| 684 "items": { | |
| 685 "type": "string" | |
| 686 }, | |
| 687 "type": "array" | |
| 688 }, | |
| 689 "name": { | |
| 690 "description": "The name of the container image that will ru
n 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 nec
essary.\n\nThe Docker daemon's cache will already have the latest versions of al
l of\nthe officially supported build steps\n(https://github.com/GoogleCloudPlatf
orm/cloud-builders). The Docker daemon\nwill also have cached many of the layers
for some popular images, like\n\"ubuntu\", \"debian\", but they will be refresh
ed at the time you attempt to\nuse them.\n\nIf you built an image in a previous
build step, it will be stored in the\nhost's Docker daemon's cache and is availa
ble to use as the name for a\nlater build step.", | |
| 691 "type": "string" | |
| 692 } | |
| 693 }, | |
| 694 "type": "object" | |
| 695 }, | |
| 696 "FileHashes": { | |
| 697 "description": "Container message for hashes of byte content of file
s, used in\nSourceProvenance messages to verify integrity of source input to the
build.", | |
| 698 "id": "FileHashes", | |
| 699 "properties": { | |
| 700 "fileHash": { | |
| 701 "description": "Collection of file hashes.", | |
| 702 "items": { | |
| 703 "$ref": "Hash" | |
| 704 }, | |
| 705 "type": "array" | |
| 706 } | |
| 707 }, | |
| 708 "type": "object" | |
| 709 }, | |
| 710 "Status": { | |
| 711 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d 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 tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\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\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage 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` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\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\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented 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 s
tripping needed for security/privacy reasons.", | |
| 712 "id": "Status", | |
| 713 "properties": { | |
| 714 "message": { | |
| 715 "description": "A developer-facing error message, which shou
ld 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.", | |
| 716 "type": "string" | |
| 717 }, | |
| 718 "details": { | |
| 719 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", | |
| 720 "items": { | |
| 721 "additionalProperties": { | |
| 722 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
| 723 "type": "any" | |
| 724 }, | |
| 725 "type": "object" | |
| 726 }, | |
| 727 "type": "array" | |
| 728 }, | |
| 729 "code": { | |
| 730 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
| 731 "format": "int32", | |
| 732 "type": "integer" | |
| 733 } | |
| 734 }, | |
| 735 "type": "object" | |
| 736 }, | |
| 737 "Empty": { | 498 "Empty": { |
| 738 "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 i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | 499 "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 i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 739 "id": "Empty", | 500 "id": "Empty", |
| 740 "properties": {}, | 501 "properties": {}, |
| 741 "type": "object" | 502 "type": "object" |
| 742 }, | 503 }, |
| 743 "BuildTrigger": { | 504 "BuildTrigger": { |
| 744 "description": "Configuration for an automated build in response to
source repository\nchanges.", | 505 "description": "Configuration for an automated build in response to
source repository\nchanges.", |
| 745 "id": "BuildTrigger", | 506 "id": "BuildTrigger", |
| 746 "properties": { | 507 "properties": { |
| 747 "substitutions": { | |
| 748 "additionalProperties": { | |
| 749 "type": "string" | |
| 750 }, | |
| 751 "description": "Substitutions data for Build resource.", | |
| 752 "type": "object" | |
| 753 }, | |
| 754 "description": { | 508 "description": { |
| 755 "description": "Human-readable description of this trigger."
, | 509 "description": "Human-readable description of this trigger."
, |
| 756 "type": "string" | 510 "type": "string" |
| 757 }, | 511 }, |
| 512 "disabled": { |
| 513 "description": "If true, the trigger will never result in a
build.", |
| 514 "type": "boolean" |
| 515 }, |
| 758 "createTime": { | 516 "createTime": { |
| 759 "description": "Time when the trigger was created.\n\n@Outpu
tOnly", | 517 "description": "Time when the trigger was created.\n\n@Outpu
tOnly", |
| 760 "format": "google-datetime", | 518 "format": "google-datetime", |
| 761 "type": "string" | 519 "type": "string" |
| 762 }, | 520 }, |
| 763 "disabled": { | |
| 764 "description": "If true, the trigger will never result in a
build.", | |
| 765 "type": "boolean" | |
| 766 }, | |
| 767 "triggerTemplate": { | 521 "triggerTemplate": { |
| 768 "$ref": "RepoSource", | 522 "$ref": "RepoSource", |
| 769 "description": "Template describing the types of source chan
ges to trigger a build.\n\nBranch and tag names in trigger templates are interpr
eted as regular\nexpressions. Any branch or tag change that matches that regular
expression\nwill trigger a build." | 523 "description": "Template describing the types of source chan
ges to trigger a build.\n\nBranch and tag names in trigger templates are interpr
eted as regular\nexpressions. Any branch or tag change that matches that regular
expression\nwill trigger a build." |
| 770 }, | 524 }, |
| 771 "filename": { | 525 "filename": { |
| 772 "description": "Path, from the source root, to a file whose
contents is used for the\ntemplate.", | 526 "description": "Path, from the source root, to a file whose
contents is used for the\ntemplate.", |
| 773 "type": "string" | 527 "type": "string" |
| 774 }, | 528 }, |
| 775 "id": { | 529 "id": { |
| 776 "description": "Unique identifier of the trigger.\n\n@Output
Only", | 530 "description": "Unique identifier of the trigger.\n\n@Output
Only", |
| 777 "type": "string" | 531 "type": "string" |
| 778 }, | 532 }, |
| 779 "build": { | 533 "build": { |
| 780 "$ref": "Build", | 534 "$ref": "Build", |
| 781 "description": "Contents of the build template." | 535 "description": "Contents of the build template." |
| 536 }, |
| 537 "substitutions": { |
| 538 "additionalProperties": { |
| 539 "type": "string" |
| 540 }, |
| 541 "description": "Substitutions data for Build resource.", |
| 542 "type": "object" |
| 782 } | 543 } |
| 783 }, | 544 }, |
| 784 "type": "object" | 545 "type": "object" |
| 785 }, | 546 }, |
| 786 "Build": { | 547 "Build": { |
| 787 "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 (fo
r example, the builder image to run on the source), and what tag to\napply to th
e built image when it is pushed to Google Container Registry.\n\nFields can incl
ude 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 ta
g name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA s
pecified by RepoSource or\n resolved from the specified branch or tag.", | 548 "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 (fo
r example, the builder image to run on the source), and what tag to\napply to th
e built image when it is pushed to Google Container Registry.\n\nFields can incl
ude 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 ta
g name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA s
pecified by RepoSource or\n resolved from the specified branch or tag.", |
| 788 "id": "Build", | 549 "id": "Build", |
| 789 "properties": { | 550 "properties": { |
| 790 "timeout": { | 551 "createTime": { |
| 791 "description": "Amount of time that this build should be all
owed 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.", | 552 "description": "Time at which the request to create the buil
d was received.\n@OutputOnly", |
| 792 "format": "google-duration", | 553 "format": "google-datetime", |
| 554 "type": "string" |
| 555 }, |
| 556 "sourceProvenance": { |
| 557 "$ref": "SourceProvenance", |
| 558 "description": "A permanent fixed identifier for source.\n@O
utputOnly" |
| 559 }, |
| 560 "images": { |
| 561 "description": "A list of images to be pushed upon the succe
ssful completion of all build\nsteps.\n\nThe images will be pushed using the bui
lder 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 b
e pushed, the build is marked FAILURE.", |
| 562 "items": { |
| 563 "type": "string" |
| 564 }, |
| 565 "type": "array" |
| 566 }, |
| 567 "projectId": { |
| 568 "description": "ID of the project.\n@OutputOnly.", |
| 569 "type": "string" |
| 570 }, |
| 571 "logUrl": { |
| 572 "description": "URL to logs for this build in Google Cloud L
ogging.\n@OutputOnly", |
| 573 "type": "string" |
| 574 }, |
| 575 "finishTime": { |
| 576 "description": "Time at which execution of the build was fin
ished.\n\nThe difference between finish_time and start_time is the duration of t
he\nbuild's execution.\n@OutputOnly", |
| 577 "format": "google-datetime", |
| 578 "type": "string" |
| 579 }, |
| 580 "options": { |
| 581 "$ref": "BuildOptions", |
| 582 "description": "Special options for this build." |
| 583 }, |
| 584 "source": { |
| 585 "$ref": "Source", |
| 586 "description": "Describes where to find the source files to
build." |
| 587 }, |
| 588 "statusDetail": { |
| 589 "description": "Customer-readable message about the current
status.\n@OutputOnly", |
| 793 "type": "string" | 590 "type": "string" |
| 794 }, | 591 }, |
| 795 "status": { | 592 "status": { |
| 796 "description": "Status of the build.\n@OutputOnly", | 593 "description": "Status of the build.\n@OutputOnly", |
| 797 "enum": [ | 594 "enum": [ |
| 798 "STATUS_UNKNOWN", | 595 "STATUS_UNKNOWN", |
| 799 "QUEUED", | 596 "QUEUED", |
| 800 "WORKING", | 597 "WORKING", |
| 801 "SUCCESS", | 598 "SUCCESS", |
| 802 "FAILURE", | 599 "FAILURE", |
| 803 "INTERNAL_ERROR", | 600 "INTERNAL_ERROR", |
| 804 "TIMEOUT", | 601 "TIMEOUT", |
| 805 "CANCELLED" | 602 "CANCELLED" |
| 806 ], | 603 ], |
| 807 "enumDescriptions": [ | 604 "enumDescriptions": [ |
| 808 "Status of the build is unknown.", | 605 "Status of the build is unknown.", |
| 809 "Build is queued; work has not yet begun.", | 606 "Build is queued; work has not yet begun.", |
| 810 "Build is being executed.", | 607 "Build is being executed.", |
| 811 "Build finished successfully.", | 608 "Build finished successfully.", |
| 812 "Build failed to complete successfully.", | 609 "Build failed to complete successfully.", |
| 813 "Build failed due to an internal cause.", | 610 "Build failed due to an internal cause.", |
| 814 "Build took longer than was allowed.", | 611 "Build took longer than was allowed.", |
| 815 "Build was canceled by a user." | 612 "Build was canceled by a user." |
| 816 ], | 613 ], |
| 817 "type": "string" | 614 "type": "string" |
| 818 }, | 615 }, |
| 819 "statusDetail": { | 616 "timeout": { |
| 820 "description": "Customer-readable message about the current
status.\n@OutputOnly", | 617 "description": "Amount of time that this build should be all
owed 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.", |
| 821 "type": "string" | 618 "format": "google-duration", |
| 822 }, | |
| 823 "logsBucket": { | |
| 824 "description": "Google Cloud Storage bucket where logs shoul
d be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/
docs/bucket-naming#requirements)).\nLogs file names will be of the format `${log
s_bucket}/log-${build_id}.txt`.", | |
| 825 "type": "string" | 619 "type": "string" |
| 826 }, | 620 }, |
| 827 "results": { | 621 "results": { |
| 828 "$ref": "Results", | 622 "$ref": "Results", |
| 829 "description": "Results of the build.\n@OutputOnly" | 623 "description": "Results of the build.\n@OutputOnly" |
| 830 }, | 624 }, |
| 625 "logsBucket": { |
| 626 "description": "Google Cloud Storage bucket where logs shoul
d be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/
docs/bucket-naming#requirements)).\nLogs file names will be of the format `${log
s_bucket}/log-${build_id}.txt`.", |
| 627 "type": "string" |
| 628 }, |
| 831 "steps": { | 629 "steps": { |
| 832 "description": "Describes the operations to be performed on
the workspace.", | 630 "description": "Describes the operations to be performed on
the workspace.", |
| 833 "items": { | 631 "items": { |
| 834 "$ref": "BuildStep" | 632 "$ref": "BuildStep" |
| 835 }, | 633 }, |
| 836 "type": "array" | 634 "type": "array" |
| 837 }, | 635 }, |
| 838 "buildTriggerId": { | 636 "buildTriggerId": { |
| 839 "description": "The ID of the BuildTrigger that triggered th
is build, if it was\ntriggered automatically.\n@OutputOnly", | 637 "description": "The ID of the BuildTrigger that triggered th
is build, if it was\ntriggered automatically.\n@OutputOnly", |
| 840 "type": "string" | 638 "type": "string" |
| 841 }, | 639 }, |
| 842 "id": { | 640 "id": { |
| 843 "description": "Unique identifier of the build.\n@OutputOnly
", | 641 "description": "Unique identifier of the build.\n@OutputOnly
", |
| 844 "type": "string" | 642 "type": "string" |
| 845 }, | 643 }, |
| 846 "startTime": { | 644 "startTime": { |
| 847 "description": "Time at which execution of the build was sta
rted.\n@OutputOnly", | 645 "description": "Time at which execution of the build was sta
rted.\n@OutputOnly", |
| 848 "format": "google-datetime", | 646 "format": "google-datetime", |
| 849 "type": "string" | 647 "type": "string" |
| 850 }, | 648 }, |
| 851 "substitutions": { | 649 "substitutions": { |
| 852 "additionalProperties": { | 650 "additionalProperties": { |
| 853 "type": "string" | 651 "type": "string" |
| 854 }, | 652 }, |
| 855 "description": "Substitutions data for Build resource.", | 653 "description": "Substitutions data for Build resource.", |
| 856 "type": "object" | 654 "type": "object" |
| 857 }, | |
| 858 "sourceProvenance": { | |
| 859 "$ref": "SourceProvenance", | |
| 860 "description": "A permanent fixed identifier for source.\n@O
utputOnly" | |
| 861 }, | |
| 862 "createTime": { | |
| 863 "description": "Time at which the request to create the buil
d was received.\n@OutputOnly", | |
| 864 "format": "google-datetime", | |
| 865 "type": "string" | |
| 866 }, | |
| 867 "images": { | |
| 868 "description": "A list of images to be pushed upon the succe
ssful completion of all build\nsteps.\n\nThe images will be pushed using the bui
lder 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 b
e pushed, the build is marked FAILURE.", | |
| 869 "items": { | |
| 870 "type": "string" | |
| 871 }, | |
| 872 "type": "array" | |
| 873 }, | |
| 874 "projectId": { | |
| 875 "description": "ID of the project.\n@OutputOnly.", | |
| 876 "type": "string" | |
| 877 }, | |
| 878 "finishTime": { | |
| 879 "description": "Time at which execution of the build was fin
ished.\n\nThe difference between finish_time and start_time is the duration of t
he\nbuild's execution.\n@OutputOnly", | |
| 880 "format": "google-datetime", | |
| 881 "type": "string" | |
| 882 }, | |
| 883 "logUrl": { | |
| 884 "description": "URL to logs for this build in Google Cloud L
ogging.\n@OutputOnly", | |
| 885 "type": "string" | |
| 886 }, | |
| 887 "options": { | |
| 888 "$ref": "BuildOptions", | |
| 889 "description": "Special options for this build." | |
| 890 }, | |
| 891 "source": { | |
| 892 "$ref": "Source", | |
| 893 "description": "Describes where to find the source files to
build." | |
| 894 } | 655 } |
| 895 }, | 656 }, |
| 896 "type": "object" | 657 "type": "object" |
| 897 }, | 658 }, |
| 898 "CancelBuildRequest": { | 659 "CancelBuildRequest": { |
| 899 "description": "Request to cancel an ongoing build.", | 660 "description": "Request to cancel an ongoing build.", |
| 900 "id": "CancelBuildRequest", | 661 "id": "CancelBuildRequest", |
| 901 "properties": {}, | 662 "properties": {}, |
| 902 "type": "object" | 663 "type": "object" |
| 903 }, | 664 }, |
| (...skipping 12 matching lines...) Expand all Loading... |
| 916 }, | 677 }, |
| 917 "type": "array" | 678 "type": "array" |
| 918 } | 679 } |
| 919 }, | 680 }, |
| 920 "type": "object" | 681 "type": "object" |
| 921 }, | 682 }, |
| 922 "ListOperationsResponse": { | 683 "ListOperationsResponse": { |
| 923 "description": "The response message for Operations.ListOperations."
, | 684 "description": "The response message for Operations.ListOperations."
, |
| 924 "id": "ListOperationsResponse", | 685 "id": "ListOperationsResponse", |
| 925 "properties": { | 686 "properties": { |
| 926 "nextPageToken": { | |
| 927 "description": "The standard List next-page token.", | |
| 928 "type": "string" | |
| 929 }, | |
| 930 "operations": { | 687 "operations": { |
| 931 "description": "A list of operations that matches the specif
ied filter in the request.", | 688 "description": "A list of operations that matches the specif
ied filter in the request.", |
| 932 "items": { | 689 "items": { |
| 933 "$ref": "Operation" | 690 "$ref": "Operation" |
| 934 }, | 691 }, |
| 935 "type": "array" | 692 "type": "array" |
| 693 }, |
| 694 "nextPageToken": { |
| 695 "description": "The standard List next-page token.", |
| 696 "type": "string" |
| 936 } | 697 } |
| 937 }, | 698 }, |
| 938 "type": "object" | 699 "type": "object" |
| 939 }, | 700 }, |
| 940 "Source": { | 701 "Source": { |
| 941 "description": "Source describes the location of the source in a sup
ported storage\nservice.", | 702 "description": "Source describes the location of the source in a sup
ported storage\nservice.", |
| 942 "id": "Source", | 703 "id": "Source", |
| 943 "properties": { | 704 "properties": { |
| 705 "repoSource": { |
| 706 "$ref": "RepoSource", |
| 707 "description": "If provided, get source from this location i
n a Cloud Repo." |
| 708 }, |
| 944 "storageSource": { | 709 "storageSource": { |
| 945 "$ref": "StorageSource", | 710 "$ref": "StorageSource", |
| 946 "description": "If provided, get the source from this locati
on in in Google Cloud\nStorage." | 711 "description": "If provided, get the source from this locati
on in in Google Cloud\nStorage." |
| 947 }, | |
| 948 "repoSource": { | |
| 949 "$ref": "RepoSource", | |
| 950 "description": "If provided, get source from this location i
n a Cloud Repo." | |
| 951 } | 712 } |
| 952 }, | 713 }, |
| 953 "type": "object" | 714 "type": "object" |
| 954 }, | 715 }, |
| 955 "BuildOptions": { | 716 "BuildOptions": { |
| 956 "description": "Optional arguments to enable specific features of bu
ilds.", | 717 "description": "Optional arguments to enable specific features of bu
ilds.", |
| 957 "id": "BuildOptions", | 718 "id": "BuildOptions", |
| 958 "properties": { | 719 "properties": { |
| 720 "requestedVerifyOption": { |
| 721 "description": "Requested verifiability options.", |
| 722 "enum": [ |
| 723 "NOT_VERIFIED", |
| 724 "VERIFIED" |
| 725 ], |
| 726 "enumDescriptions": [ |
| 727 "Not a verifiable build. (default)", |
| 728 "Verified build." |
| 729 ], |
| 730 "type": "string" |
| 731 }, |
| 959 "sourceProvenanceHash": { | 732 "sourceProvenanceHash": { |
| 960 "description": "Requested hash for SourceProvenance.", | 733 "description": "Requested hash for SourceProvenance.", |
| 961 "enumDescriptions": [ | 734 "enumDescriptions": [ |
| 962 "No hash requested.", | 735 "No hash requested.", |
| 963 "Use a sha256 hash." | 736 "Use a sha256 hash." |
| 964 ], | 737 ], |
| 965 "items": { | 738 "items": { |
| 966 "enum": [ | 739 "enum": [ |
| 967 "NONE", | 740 "NONE", |
| 968 "SHA256" | 741 "SHA256" |
| 969 ], | 742 ], |
| 970 "type": "string" | 743 "type": "string" |
| 971 }, | 744 }, |
| 972 "type": "array" | 745 "type": "array" |
| 973 }, | |
| 974 "requestedVerifyOption": { | |
| 975 "description": "Requested verifiability options.", | |
| 976 "enum": [ | |
| 977 "NOT_VERIFIED", | |
| 978 "VERIFIED" | |
| 979 ], | |
| 980 "enumDescriptions": [ | |
| 981 "Not a verifiable build. (default)", | |
| 982 "Verified build." | |
| 983 ], | |
| 984 "type": "string" | |
| 985 } | 746 } |
| 986 }, | 747 }, |
| 987 "type": "object" | 748 "type": "object" |
| 988 }, | 749 }, |
| 989 "StorageSource": { | 750 "StorageSource": { |
| 990 "description": "StorageSource describes the location of the source i
n an archive file in\nGoogle Cloud Storage.", | 751 "description": "StorageSource describes the location of the source i
n an archive file in\nGoogle Cloud Storage.", |
| 991 "id": "StorageSource", | 752 "id": "StorageSource", |
| 992 "properties": { | 753 "properties": { |
| 993 "generation": { | 754 "generation": { |
| 994 "description": "Google Cloud Storage generation for the obje
ct. If the generation is\nomitted, the latest generation will be used.", | 755 "description": "Google Cloud Storage generation for the obje
ct. If the generation is\nomitted, the latest generation will be used.", |
| (...skipping 24 matching lines...) Expand all Loading... |
| 1019 }, | 780 }, |
| 1020 "images": { | 781 "images": { |
| 1021 "description": "Images that were built as a part of the buil
d.", | 782 "description": "Images that were built as a part of the buil
d.", |
| 1022 "items": { | 783 "items": { |
| 1023 "$ref": "BuiltImage" | 784 "$ref": "BuiltImage" |
| 1024 }, | 785 }, |
| 1025 "type": "array" | 786 "type": "array" |
| 1026 } | 787 } |
| 1027 }, | 788 }, |
| 1028 "type": "object" | 789 "type": "object" |
| 790 }, |
| 791 "BuildOperationMetadata": { |
| 792 "description": "Metadata for build operations.", |
| 793 "id": "BuildOperationMetadata", |
| 794 "properties": { |
| 795 "build": { |
| 796 "$ref": "Build", |
| 797 "description": "The build that the operation is tracking." |
| 798 } |
| 799 }, |
| 800 "type": "object" |
| 801 }, |
| 802 "SourceProvenance": { |
| 803 "description": "Provenance of the source. Ways to find the original
source, or verify that\nsome source was used for this build.", |
| 804 "id": "SourceProvenance", |
| 805 "properties": { |
| 806 "resolvedRepoSource": { |
| 807 "$ref": "RepoSource", |
| 808 "description": "A copy of the build's source.repo_source, if
exists, with any\nrevisions resolved." |
| 809 }, |
| 810 "resolvedStorageSource": { |
| 811 "$ref": "StorageSource", |
| 812 "description": "A copy of the build's source.storage_source,
if exists, with any\ngenerations resolved." |
| 813 }, |
| 814 "fileHashes": { |
| 815 "additionalProperties": { |
| 816 "$ref": "FileHashes" |
| 817 }, |
| 818 "description": "Hash(es) of the build source, which can be u
sed to verify that the original\nsource integrity was maintained in the build. N
ote that FileHashes will\nonly be populated if BuildOptions has requested a Sour
ceProvenanceHash.\n\nThe keys to this map are file paths used as build source an
d the values\ncontain the hash values for those files.\n\nIf the build source ca
me in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will b
e for the single path to that file.\n@OutputOnly", |
| 819 "type": "object" |
| 820 } |
| 821 }, |
| 822 "type": "object" |
| 823 }, |
| 824 "CancelOperationRequest": { |
| 825 "description": "The request message for Operations.CancelOperation."
, |
| 826 "id": "CancelOperationRequest", |
| 827 "properties": {}, |
| 828 "type": "object" |
| 829 }, |
| 830 "Operation": { |
| 831 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
| 832 "id": "Operation", |
| 833 "properties": { |
| 834 "error": { |
| 835 "$ref": "Status", |
| 836 "description": "The error result of the operation in case of
failure or cancellation." |
| 837 }, |
| 838 "metadata": { |
| 839 "additionalProperties": { |
| 840 "description": "Properties of the object. Contains field
@type with type URL.", |
| 841 "type": "any" |
| 842 }, |
| 843 "description": "Service-specific metadata associated with th
e operation. It typically\ncontains progress information and common metadata su
ch as create time.\nSome services might not provide such metadata. Any method t
hat returns a\nlong-running operation should document the metadata type, if any.
", |
| 844 "type": "object" |
| 845 }, |
| 846 "done": { |
| 847 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf true, the operation is completed, and either `erro
r` or `response` is\navailable.", |
| 848 "type": "boolean" |
| 849 }, |
| 850 "response": { |
| 851 "additionalProperties": { |
| 852 "description": "Properties of the object. Contains field
@type with type URL.", |
| 853 "type": "any" |
| 854 }, |
| 855 "description": "The normal response of the operation in case
of success. If the original\nmethod returns no data on success, such as `Delet
e`, the response is\n`google.protobuf.Empty`. If the original method is standar
d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet
hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi
nal method name. For example, if the original method name\nis `TakeSnapshot()`,
the inferred response type is\n`TakeSnapshotResponse`.", |
| 856 "type": "object" |
| 857 }, |
| 858 "name": { |
| 859 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", |
| 860 "type": "string" |
| 861 } |
| 862 }, |
| 863 "type": "object" |
| 864 }, |
| 865 "ListBuildTriggersResponse": { |
| 866 "description": "Response containing existing BuildTriggers.", |
| 867 "id": "ListBuildTriggersResponse", |
| 868 "properties": { |
| 869 "triggers": { |
| 870 "description": "BuildTriggers for the project, sorted by cre
ate_time descending.", |
| 871 "items": { |
| 872 "$ref": "BuildTrigger" |
| 873 }, |
| 874 "type": "array" |
| 875 } |
| 876 }, |
| 877 "type": "object" |
| 878 }, |
| 879 "BuiltImage": { |
| 880 "description": "BuiltImage describes an image built by the pipeline.
", |
| 881 "id": "BuiltImage", |
| 882 "properties": { |
| 883 "name": { |
| 884 "description": "Name used to push the container image to Goo
gle Container Registry, as\npresented to `docker push`.", |
| 885 "type": "string" |
| 886 }, |
| 887 "digest": { |
| 888 "description": "Docker Registry 2.0 digest.", |
| 889 "type": "string" |
| 890 } |
| 891 }, |
| 892 "type": "object" |
| 893 }, |
| 894 "Hash": { |
| 895 "description": "Container message for hash values.", |
| 896 "id": "Hash", |
| 897 "properties": { |
| 898 "type": { |
| 899 "description": "The type of hash that was performed.", |
| 900 "enum": [ |
| 901 "NONE", |
| 902 "SHA256" |
| 903 ], |
| 904 "enumDescriptions": [ |
| 905 "No hash requested.", |
| 906 "Use a sha256 hash." |
| 907 ], |
| 908 "type": "string" |
| 909 }, |
| 910 "value": { |
| 911 "description": "The hash value.", |
| 912 "format": "byte", |
| 913 "type": "string" |
| 914 } |
| 915 }, |
| 916 "type": "object" |
| 917 }, |
| 918 "RepoSource": { |
| 919 "description": "RepoSource describes the location of the source in a
Google Cloud Source\nRepository.", |
| 920 "id": "RepoSource", |
| 921 "properties": { |
| 922 "tagName": { |
| 923 "description": "Name of the tag to build.", |
| 924 "type": "string" |
| 925 }, |
| 926 "commitSha": { |
| 927 "description": "Explicit commit SHA to build.", |
| 928 "type": "string" |
| 929 }, |
| 930 "projectId": { |
| 931 "description": "ID of the project that owns the repo. If omi
tted, the project ID requesting\nthe build is assumed.", |
| 932 "type": "string" |
| 933 }, |
| 934 "repoName": { |
| 935 "description": "Name of the repo. If omitted, the name \"def
ault\" is assumed.", |
| 936 "type": "string" |
| 937 }, |
| 938 "branchName": { |
| 939 "description": "Name of the branch to build.", |
| 940 "type": "string" |
| 941 } |
| 942 }, |
| 943 "type": "object" |
| 944 }, |
| 945 "BuildStep": { |
| 946 "description": "BuildStep describes a step to perform in the build p
ipeline.", |
| 947 "id": "BuildStep", |
| 948 "properties": { |
| 949 "dir": { |
| 950 "description": "Working directory (relative to project sourc
e root) to use when running\nthis operation's container.", |
| 951 "type": "string" |
| 952 }, |
| 953 "waitFor": { |
| 954 "description": "The ID(s) of the step(s) that this build ste
p 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\nst
art when all previous build steps in the Build.Steps list have completed\nsucces
sfully.", |
| 955 "items": { |
| 956 "type": "string" |
| 957 }, |
| 958 "type": "array" |
| 959 }, |
| 960 "env": { |
| 961 "description": "A list of environment variable definitions t
o 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\".", |
| 962 "items": { |
| 963 "type": "string" |
| 964 }, |
| 965 "type": "array" |
| 966 }, |
| 967 "args": { |
| 968 "description": "A list of arguments that will be presented t
o 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.", |
| 969 "items": { |
| 970 "type": "string" |
| 971 }, |
| 972 "type": "array" |
| 973 }, |
| 974 "name": { |
| 975 "description": "The name of the container image that will ru
n 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 nec
essary.\n\nThe Docker daemon's cache will already have the latest versions of al
l of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlat
form/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nT
he Docker daemon will also have cached many of the layers for some popular\nimag
es, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\natt
empt 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.", |
| 976 "type": "string" |
| 977 }, |
| 978 "entrypoint": { |
| 979 "description": "Optional entrypoint to be used instead of th
e build step image's default\nIf unset, the image's default will be used.", |
| 980 "type": "string" |
| 981 }, |
| 982 "id": { |
| 983 "description": "Optional unique identifier for this build st
ep, used in wait_for to\nreference this build step as a dependency.", |
| 984 "type": "string" |
| 985 } |
| 986 }, |
| 987 "type": "object" |
| 988 }, |
| 989 "FileHashes": { |
| 990 "description": "Container message for hashes of byte content of file
s, used in\nSourceProvenance messages to verify integrity of source input to the
build.", |
| 991 "id": "FileHashes", |
| 992 "properties": { |
| 993 "fileHash": { |
| 994 "description": "Collection of file hashes.", |
| 995 "items": { |
| 996 "$ref": "Hash" |
| 997 }, |
| 998 "type": "array" |
| 999 } |
| 1000 }, |
| 1001 "type": "object" |
| 1002 }, |
| 1003 "Status": { |
| 1004 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d 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 tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\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\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage 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` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\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\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented 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 s
tripping needed for security/privacy reasons.", |
| 1005 "id": "Status", |
| 1006 "properties": { |
| 1007 "code": { |
| 1008 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 1009 "format": "int32", |
| 1010 "type": "integer" |
| 1011 }, |
| 1012 "message": { |
| 1013 "description": "A developer-facing error message, which shou
ld 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.", |
| 1014 "type": "string" |
| 1015 }, |
| 1016 "details": { |
| 1017 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
| 1018 "items": { |
| 1019 "additionalProperties": { |
| 1020 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 1021 "type": "any" |
| 1022 }, |
| 1023 "type": "object" |
| 1024 }, |
| 1025 "type": "array" |
| 1026 } |
| 1027 }, |
| 1028 "type": "object" |
| 1029 } | 1029 } |
| 1030 }, | 1030 }, |
| 1031 "servicePath": "", | 1031 "servicePath": "", |
| 1032 "title": "Google Cloud Container Builder API", | 1032 "title": "Google Cloud Container Builder API", |
| 1033 "version": "v1" | 1033 "version": "v1" |
| 1034 } | 1034 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2779563003:
Api-roll 47: 2017-03-27 (Closed)
