1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://vpcaccess.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "Serverless VPC Access",
15 "description": "API for managing VPC access connectors.",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/vpc/docs/configure-serverless-vpc-access",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "vpcaccess:v1",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://vpcaccess.mtls.googleapis.com/",
26 "name": "vpcaccess",
27 "ownerDomain": "google.com",
28 "ownerName": "Google",
29 "parameters": {
30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
92 "location": "query",
93 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 }
105 },
106 "protocol": "rest",
107 "resources": {
108 "projects": {
109 "resources": {
110 "locations": {
111 "methods": {
112 "list": {
113 "description": "Lists information about the supported locations for this service.",
114 "flatPath": "v1/projects/{projectsId}/locations",
115 "httpMethod": "GET",
116 "id": "vpcaccess.projects.locations.list",
117 "parameterOrder": [
118 "name"
119 ],
120 "parameters": {
121 "filter": {
122 "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
123 "location": "query",
124 "type": "string"
125 },
126 "name": {
127 "description": "The resource that owns the locations collection, if applicable.",
128 "location": "path",
129 "pattern": "^projects/[^/]+$",
130 "required": true,
131 "type": "string"
132 },
133 "pageSize": {
134 "description": "The maximum number of results to return. If not set, the service selects a default.",
135 "format": "int32",
136 "location": "query",
137 "type": "integer"
138 },
139 "pageToken": {
140 "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
141 "location": "query",
142 "type": "string"
143 }
144 },
145 "path": "v1/{+name}/locations",
146 "response": {
147 "$ref": "ListLocationsResponse"
148 },
149 "scopes": [
150 "https://www.googleapis.com/auth/cloud-platform"
151 ]
152 }
153 },
154 "resources": {
155 "connectors": {
156 "methods": {
157 "create": {
158 "description": "Creates a Serverless VPC Access connector, returns an operation.",
159 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectors",
160 "httpMethod": "POST",
161 "id": "vpcaccess.projects.locations.connectors.create",
162 "parameterOrder": [
163 "parent"
164 ],
165 "parameters": {
166 "connectorId": {
167 "description": "Required. The ID to use for this connector.",
168 "location": "query",
169 "type": "string"
170 },
171 "parent": {
172 "description": "Required. The project ID and location in which the configuration should be created, specified in the format `projects/*/locations/*`.",
173 "location": "path",
174 "pattern": "^projects/[^/]+/locations/[^/]+$",
175 "required": true,
176 "type": "string"
177 }
178 },
179 "path": "v1/{+parent}/connectors",
180 "request": {
181 "$ref": "Connector"
182 },
183 "response": {
184 "$ref": "Operation"
185 },
186 "scopes": [
187 "https://www.googleapis.com/auth/cloud-platform"
188 ]
189 },
190 "delete": {
191 "description": "Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.",
192 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}",
193 "httpMethod": "DELETE",
194 "id": "vpcaccess.projects.locations.connectors.delete",
195 "parameterOrder": [
196 "name"
197 ],
198 "parameters": {
199 "name": {
200 "description": "Required. Name of a Serverless VPC Access connector to delete.",
201 "location": "path",
202 "pattern": "^projects/[^/]+/locations/[^/]+/connectors/[^/]+$",
203 "required": true,
204 "type": "string"
205 }
206 },
207 "path": "v1/{+name}",
208 "response": {
209 "$ref": "Operation"
210 },
211 "scopes": [
212 "https://www.googleapis.com/auth/cloud-platform"
213 ]
214 },
215 "get": {
216 "description": "Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.",
217 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}",
218 "httpMethod": "GET",
219 "id": "vpcaccess.projects.locations.connectors.get",
220 "parameterOrder": [
221 "name"
222 ],
223 "parameters": {
224 "name": {
225 "description": "Required. Name of a Serverless VPC Access connector to get.",
226 "location": "path",
227 "pattern": "^projects/[^/]+/locations/[^/]+/connectors/[^/]+$",
228 "required": true,
229 "type": "string"
230 }
231 },
232 "path": "v1/{+name}",
233 "response": {
234 "$ref": "Connector"
235 },
236 "scopes": [
237 "https://www.googleapis.com/auth/cloud-platform"
238 ]
239 },
240 "list": {
241 "description": "Lists Serverless VPC Access connectors.",
242 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectors",
243 "httpMethod": "GET",
244 "id": "vpcaccess.projects.locations.connectors.list",
245 "parameterOrder": [
246 "parent"
247 ],
248 "parameters": {
249 "pageSize": {
250 "description": "Maximum number of functions to return per call.",
251 "format": "int32",
252 "location": "query",
253 "type": "integer"
254 },
255 "pageToken": {
256 "description": "Continuation token.",
257 "location": "query",
258 "type": "string"
259 },
260 "parent": {
261 "description": "Required. The project and location from which the routes should be listed.",
262 "location": "path",
263 "pattern": "^projects/[^/]+/locations/[^/]+$",
264 "required": true,
265 "type": "string"
266 }
267 },
268 "path": "v1/{+parent}/connectors",
269 "response": {
270 "$ref": "ListConnectorsResponse"
271 },
272 "scopes": [
273 "https://www.googleapis.com/auth/cloud-platform"
274 ]
275 },
276 "patch": {
277 "description": "Updates a Serverless VPC Access connector, returns an operation.",
278 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}",
279 "httpMethod": "PATCH",
280 "id": "vpcaccess.projects.locations.connectors.patch",
281 "parameterOrder": [
282 "name"
283 ],
284 "parameters": {
285 "name": {
286 "description": "The resource name in the format `projects/*/locations/*/connectors/*`.",
287 "location": "path",
288 "pattern": "^projects/[^/]+/locations/[^/]+/connectors/[^/]+$",
289 "required": true,
290 "type": "string"
291 },
292 "updateMask": {
293 "description": "The fields to update on the entry group. If absent or empty, all modifiable fields are updated.",
294 "format": "google-fieldmask",
295 "location": "query",
296 "type": "string"
297 }
298 },
299 "path": "v1/{+name}",
300 "request": {
301 "$ref": "Connector"
302 },
303 "response": {
304 "$ref": "Operation"
305 },
306 "scopes": [
307 "https://www.googleapis.com/auth/cloud-platform"
308 ]
309 }
310 }
311 },
312 "operations": {
313 "methods": {
314 "get": {
315 "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.",
316 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
317 "httpMethod": "GET",
318 "id": "vpcaccess.projects.locations.operations.get",
319 "parameterOrder": [
320 "name"
321 ],
322 "parameters": {
323 "name": {
324 "description": "The name of the operation resource.",
325 "location": "path",
326 "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
327 "required": true,
328 "type": "string"
329 }
330 },
331 "path": "v1/{+name}",
332 "response": {
333 "$ref": "Operation"
334 },
335 "scopes": [
336 "https://www.googleapis.com/auth/cloud-platform"
337 ]
338 },
339 "list": {
340 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
341 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
342 "httpMethod": "GET",
343 "id": "vpcaccess.projects.locations.operations.list",
344 "parameterOrder": [
345 "name"
346 ],
347 "parameters": {
348 "filter": {
349 "description": "The standard list filter.",
350 "location": "query",
351 "type": "string"
352 },
353 "name": {
354 "description": "The name of the operation's parent resource.",
355 "location": "path",
356 "pattern": "^projects/[^/]+/locations/[^/]+$",
357 "required": true,
358 "type": "string"
359 },
360 "pageSize": {
361 "description": "The standard list page size.",
362 "format": "int32",
363 "location": "query",
364 "type": "integer"
365 },
366 "pageToken": {
367 "description": "The standard list page token.",
368 "location": "query",
369 "type": "string"
370 }
371 },
372 "path": "v1/{+name}/operations",
373 "response": {
374 "$ref": "ListOperationsResponse"
375 },
376 "scopes": [
377 "https://www.googleapis.com/auth/cloud-platform"
378 ]
379 }
380 }
381 }
382 }
383 }
384 }
385 }
386 },
387 "revision": "20231110",
388 "rootUrl": "https://vpcaccess.googleapis.com/",
389 "schemas": {
390 "Connector": {
391 "description": "Definition of a Serverless VPC Access connector.",
392 "id": "Connector",
393 "properties": {
394 "connectedProjects": {
395 "description": "Output only. List of projects using the connector.",
396 "items": {
397 "type": "string"
398 },
399 "readOnly": true,
400 "type": "array"
401 },
402 "ipCidrRange": {
403 "description": "The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.",
404 "type": "string"
405 },
406 "machineType": {
407 "description": "Machine type of VM Instance underlying connector. Default is e2-micro",
408 "type": "string"
409 },
410 "maxInstances": {
411 "description": "Maximum value of instances in autoscaling group underlying the connector.",
412 "format": "int32",
413 "type": "integer"
414 },
415 "maxThroughput": {
416 "description": "Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.",
417 "format": "int32",
418 "type": "integer"
419 },
420 "minInstances": {
421 "description": "Minimum value of instances in autoscaling group underlying the connector.",
422 "format": "int32",
423 "type": "integer"
424 },
425 "minThroughput": {
426 "description": "Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.",
427 "format": "int32",
428 "type": "integer"
429 },
430 "name": {
431 "description": "The resource name in the format `projects/*/locations/*/connectors/*`.",
432 "type": "string"
433 },
434 "network": {
435 "description": "Name of a VPC network.",
436 "type": "string"
437 },
438 "state": {
439 "description": "Output only. State of the VPC access connector.",
440 "enum": [
441 "STATE_UNSPECIFIED",
442 "READY",
443 "CREATING",
444 "DELETING",
445 "ERROR",
446 "UPDATING"
447 ],
448 "enumDescriptions": [
449 "Invalid state.",
450 "Connector is deployed and ready to receive traffic.",
451 "An Insert operation is in progress. Transient condition.",
452 "A Delete operation is in progress. Transient condition.",
453 "Connector is in a bad state, manual deletion recommended.",
454 "The connector is being updated."
455 ],
456 "readOnly": true,
457 "type": "string"
458 },
459 "subnet": {
460 "$ref": "Subnet",
461 "description": "The subnet in which to house the VPC Access Connector."
462 }
463 },
464 "type": "object"
465 },
466 "ListConnectorsResponse": {
467 "description": "Response for listing Serverless VPC Access connectors.",
468 "id": "ListConnectorsResponse",
469 "properties": {
470 "connectors": {
471 "description": "List of Serverless VPC Access connectors.",
472 "items": {
473 "$ref": "Connector"
474 },
475 "type": "array"
476 },
477 "nextPageToken": {
478 "description": "Continuation token.",
479 "type": "string"
480 }
481 },
482 "type": "object"
483 },
484 "ListLocationsResponse": {
485 "description": "The response message for Locations.ListLocations.",
486 "id": "ListLocationsResponse",
487 "properties": {
488 "locations": {
489 "description": "A list of locations that matches the specified filter in the request.",
490 "items": {
491 "$ref": "Location"
492 },
493 "type": "array"
494 },
495 "nextPageToken": {
496 "description": "The standard List next-page token.",
497 "type": "string"
498 }
499 },
500 "type": "object"
501 },
502 "ListOperationsResponse": {
503 "description": "The response message for Operations.ListOperations.",
504 "id": "ListOperationsResponse",
505 "properties": {
506 "nextPageToken": {
507 "description": "The standard List next-page token.",
508 "type": "string"
509 },
510 "operations": {
511 "description": "A list of operations that matches the specified filter in the request.",
512 "items": {
513 "$ref": "Operation"
514 },
515 "type": "array"
516 }
517 },
518 "type": "object"
519 },
520 "Location": {
521 "description": "A resource that represents a Google Cloud location.",
522 "id": "Location",
523 "properties": {
524 "displayName": {
525 "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
526 "type": "string"
527 },
528 "labels": {
529 "additionalProperties": {
530 "type": "string"
531 },
532 "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
533 "type": "object"
534 },
535 "locationId": {
536 "description": "The canonical id for this location. For example: `\"us-east1\"`.",
537 "type": "string"
538 },
539 "metadata": {
540 "additionalProperties": {
541 "description": "Properties of the object. Contains field @type with type URL.",
542 "type": "any"
543 },
544 "description": "Service-specific metadata. For example the available capacity at the given location.",
545 "type": "object"
546 },
547 "name": {
548 "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
549 "type": "string"
550 }
551 },
552 "type": "object"
553 },
554 "Operation": {
555 "description": "This resource represents a long-running operation that is the result of a network API call.",
556 "id": "Operation",
557 "properties": {
558 "done": {
559 "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.",
560 "type": "boolean"
561 },
562 "error": {
563 "$ref": "Status",
564 "description": "The error result of the operation in case of failure or cancellation."
565 },
566 "metadata": {
567 "additionalProperties": {
568 "description": "Properties of the object. Contains field @type with type URL.",
569 "type": "any"
570 },
571 "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.",
572 "type": "object"
573 },
574 "name": {
575 "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 be a resource name ending with `operations/{unique_id}`.",
576 "type": "string"
577 },
578 "response": {
579 "additionalProperties": {
580 "description": "Properties of the object. Contains field @type with type URL.",
581 "type": "any"
582 },
583 "description": "The normal, successful response of the operation. 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`.",
584 "type": "object"
585 }
586 },
587 "type": "object"
588 },
589 "OperationMetadata": {
590 "description": "Metadata for google.longrunning.Operation.",
591 "id": "OperationMetadata",
592 "properties": {
593 "createTime": {
594 "description": "Output only. Time when the operation was created.",
595 "format": "google-datetime",
596 "readOnly": true,
597 "type": "string"
598 },
599 "endTime": {
600 "description": "Output only. Time when the operation completed.",
601 "format": "google-datetime",
602 "readOnly": true,
603 "type": "string"
604 },
605 "method": {
606 "description": "Output only. Method that initiated the operation e.g. google.cloud.vpcaccess.v1.Connectors.CreateConnector.",
607 "readOnly": true,
608 "type": "string"
609 },
610 "target": {
611 "description": "Output only. Name of the resource that this operation is acting on e.g. projects/my-project/locations/us-central1/connectors/v1.",
612 "readOnly": true,
613 "type": "string"
614 }
615 },
616 "type": "object"
617 },
618 "OperationMetadataV1Alpha1": {
619 "description": "Metadata for google.longrunning.Operation.",
620 "id": "OperationMetadataV1Alpha1",
621 "properties": {
622 "endTime": {
623 "description": "Output only. Time when the operation completed.",
624 "format": "google-datetime",
625 "readOnly": true,
626 "type": "string"
627 },
628 "insertTime": {
629 "description": "Output only. Time when the operation was created.",
630 "format": "google-datetime",
631 "readOnly": true,
632 "type": "string"
633 },
634 "method": {
635 "description": "Output only. Method that initiated the operation e.g. google.cloud.vpcaccess.v1alpha1.Connectors.CreateConnector.",
636 "readOnly": true,
637 "type": "string"
638 },
639 "target": {
640 "description": "Output only. Name of the resource that this operation is acting on e.g. projects/my-project/locations/us-central1/connectors/v1.",
641 "readOnly": true,
642 "type": "string"
643 }
644 },
645 "type": "object"
646 },
647 "OperationMetadataV1Beta1": {
648 "description": "Metadata for google.longrunning.Operation.",
649 "id": "OperationMetadataV1Beta1",
650 "properties": {
651 "createTime": {
652 "description": "Output only. Time when the operation was created.",
653 "format": "google-datetime",
654 "readOnly": true,
655 "type": "string"
656 },
657 "endTime": {
658 "description": "Output only. Time when the operation completed.",
659 "format": "google-datetime",
660 "readOnly": true,
661 "type": "string"
662 },
663 "method": {
664 "description": "Output only. Method that initiated the operation e.g. google.cloud.vpcaccess.v1beta1.Connectors.CreateConnector.",
665 "readOnly": true,
666 "type": "string"
667 },
668 "target": {
669 "description": "Output only. Name of the resource that this operation is acting on e.g. projects/my-project/locations/us-central1/connectors/v1.",
670 "readOnly": true,
671 "type": "string"
672 }
673 },
674 "type": "object"
675 },
676 "Status": {
677 "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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
678 "id": "Status",
679 "properties": {
680 "code": {
681 "description": "The status code, which should be an enum value of google.rpc.Code.",
682 "format": "int32",
683 "type": "integer"
684 },
685 "details": {
686 "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
687 "items": {
688 "additionalProperties": {
689 "description": "Properties of the object. Contains field @type with type URL.",
690 "type": "any"
691 },
692 "type": "object"
693 },
694 "type": "array"
695 },
696 "message": {
697 "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.",
698 "type": "string"
699 }
700 },
701 "type": "object"
702 },
703 "Subnet": {
704 "description": "The subnet in which to house the connector",
705 "id": "Subnet",
706 "properties": {
707 "name": {
708 "description": "Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}",
709 "type": "string"
710 },
711 "projectId": {
712 "description": "Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.",
713 "type": "string"
714 }
715 },
716 "type": "object"
717 }
718 },
719 "servicePath": "",
720 "title": "Serverless VPC Access API",
721 "version": "v1",
722 "version_module": true
723}View as plain text