Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vpcaccess.v1.Connector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.vpcaccess.v1.CreateConnectorRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vpcaccess.v1.Connector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
GetConnector(std::string const &, Options)
Gets a Serverless VPC Access connector.
Returns NOT_FOUND if the resource does not exist.
Parameters
Name
Description
name
std::string const &
Required. Name of a Serverless VPC Access connector to get.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.vpcaccess.v1.GetConnectorRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.vpcaccess.v1.Connector, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.vpcaccess.v1.ListConnectorsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.vpcaccess.v1.Connector, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
DeleteConnector(std::string const &, Options)
Deletes a Serverless VPC Access connector.
Returns NOT_FOUND if the resource does not exist.
Parameters
Name
Description
name
std::string const &
Required. Name of a Serverless VPC Access connector to delete.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vpcaccess.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.vpcaccess.v1.DeleteConnectorRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vpcaccess.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis page details the \u003ccode\u003eVpcAccessServiceClient\u003c/code\u003e for the Serverless VPC Access API, which lets users manage connectors for App Engine, Cloud Functions, and Cloud Run to have internal connections to Virtual Private Cloud networks.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the client is \u003ccode\u003e2.37.0-rc\u003c/code\u003e, and the page also lists numerous previous versions from \u003ccode\u003e2.36.0\u003c/code\u003e to \u003ccode\u003e2.11.0\u003c/code\u003e, with \u003ccode\u003e2.21.0\u003c/code\u003e being the primary version in the dropdown.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eVpcAccessServiceClient\u003c/code\u003e instances created through copying or with equal \u003ccode\u003estd::shared_ptr<Connection>\u003c/code\u003e objects are equivalent and share the same resources, however, concurrent access to the same object is not thread safe.\u003c/p\u003e\n"],["\u003cp\u003eThe client offers functions to manage connectors such as \u003ccode\u003eCreateConnector\u003c/code\u003e, \u003ccode\u003eGetConnector\u003c/code\u003e, \u003ccode\u003eListConnectors\u003c/code\u003e, and \u003ccode\u003eDeleteConnector\u003c/code\u003e, with each function having variants for direct parameter input and \u003ccode\u003erequest\u003c/code\u003e proto message input.\u003c/p\u003e\n"],["\u003cp\u003eFunctions like \u003ccode\u003eCreateConnector\u003c/code\u003e and \u003ccode\u003eDeleteConnector\u003c/code\u003e return a \u003ccode\u003efuture\u003c/code\u003e that resolves with the completion of a Long Running Operation (LRO), and all connector functions can be overridden with custom retry and backoff policies using \u003ccode\u003eOptions\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Class VpcAccessServiceClient (2.21.0)\n\nVersion 2.21.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/vpcaccess/latest/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.41.0](/cpp/docs/reference/vpcaccess/2.41.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.40.0](/cpp/docs/reference/vpcaccess/2.40.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.39.0](/cpp/docs/reference/vpcaccess/2.39.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.38.0](/cpp/docs/reference/vpcaccess/2.38.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.37.0](/cpp/docs/reference/vpcaccess/2.37.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.36.0](/cpp/docs/reference/vpcaccess/2.36.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.35.0](/cpp/docs/reference/vpcaccess/2.35.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.34.0](/cpp/docs/reference/vpcaccess/2.34.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.33.0](/cpp/docs/reference/vpcaccess/2.33.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.32.0](/cpp/docs/reference/vpcaccess/2.32.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.31.0](/cpp/docs/reference/vpcaccess/2.31.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.30.0](/cpp/docs/reference/vpcaccess/2.30.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.29.0](/cpp/docs/reference/vpcaccess/2.29.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.28.0](/cpp/docs/reference/vpcaccess/2.28.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.27.0](/cpp/docs/reference/vpcaccess/2.27.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.26.0](/cpp/docs/reference/vpcaccess/2.26.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.25.1](/cpp/docs/reference/vpcaccess/2.25.1/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.24.0](/cpp/docs/reference/vpcaccess/2.24.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.23.0](/cpp/docs/reference/vpcaccess/2.23.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.22.1](/cpp/docs/reference/vpcaccess/2.22.1/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.21.0](/cpp/docs/reference/vpcaccess/2.21.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.20.0](/cpp/docs/reference/vpcaccess/2.20.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.19.0](/cpp/docs/reference/vpcaccess/2.19.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.18.0](/cpp/docs/reference/vpcaccess/2.18.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.17.0](/cpp/docs/reference/vpcaccess/2.17.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.16.0](/cpp/docs/reference/vpcaccess/2.16.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.15.1](/cpp/docs/reference/vpcaccess/2.15.1/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.14.0](/cpp/docs/reference/vpcaccess/2.14.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.13.0](/cpp/docs/reference/vpcaccess/2.13.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.12.0](/cpp/docs/reference/vpcaccess/2.12.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient)\n- [2.11.0](/cpp/docs/reference/vpcaccess/2.11.0/classgoogle_1_1cloud_1_1vpcaccess__v1_1_1VpcAccessServiceClient) \nServerless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks. \n\n###### Equality\n\nInstances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal `std::shared_ptr\u003c*Connection\u003e` objects compare equal. Objects that compare equal share the same underlying resources.\n\n###### Performance\n\nCreating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.\n\n###### Thread Safety\n\nConcurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.\n\nConstructors\n------------\n\n### VpcAccessServiceClient(VpcAccessServiceClient const \\&)\n\nCopy and move support\n\n### VpcAccessServiceClient(VpcAccessServiceClient \\&\\&)\n\nCopy and move support\n\n### VpcAccessServiceClient(std::shared_ptr\\\u003c VpcAccessServiceConnection \\\u003e, Options)\n\nOperators\n---------\n\n### operator=(VpcAccessServiceClient const \\&)\n\nCopy and move support\n\n### operator=(VpcAccessServiceClient \\&\\&)\n\nCopy and move support\n\nFunctions\n---------\n\n### CreateConnector(std::string const \\&, std::string const \\&, google::cloud::vpcaccess::v1::Connector const \\&, Options)\n\nCreates a Serverless VPC Access connector, returns an operation.\n\n### CreateConnector(google::cloud::vpcaccess::v1::CreateConnectorRequest const \\&, Options)\n\nCreates a Serverless VPC Access connector, returns an operation.\n\n### GetConnector(std::string const \\&, Options)\n\nGets a Serverless VPC Access connector. \nReturns NOT_FOUND if the resource does not exist.\n\n### GetConnector(google::cloud::vpcaccess::v1::GetConnectorRequest const \\&, Options)\n\nGets a Serverless VPC Access connector. \nReturns NOT_FOUND if the resource does not exist.\n\n### ListConnectors(std::string const \\&, Options)\n\nLists Serverless VPC Access connectors.\n\n### ListConnectors(google::cloud::vpcaccess::v1::ListConnectorsRequest, Options)\n\nLists Serverless VPC Access connectors.\n\n### DeleteConnector(std::string const \\&, Options)\n\nDeletes a Serverless VPC Access connector. \nReturns NOT_FOUND if the resource does not exist.\n\n### DeleteConnector(google::cloud::vpcaccess::v1::DeleteConnectorRequest const \\&, Options)\n\nDeletes a Serverless VPC Access connector. \nReturns NOT_FOUND if the resource does not exist."]]
