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.
Required. The parent, which owns this collection of endpoints.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Returns
Type
Description
StreamRange< google::cloud::ids::v1::Endpoint >
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.ids.v1.Endpoint, 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.ids.v1.ListEndpointsRequest. 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.
Returns
Type
Description
StreamRange< google::cloud::ids::v1::Endpoint >
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.ids.v1.Endpoint, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
GetEndpoint(std::string const &, Options)
Gets details of a single Endpoint.
Parameters
Name
Description
name
std::string const &
Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint}
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.ids.v1.GetEndpointRequest. 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.
Creates a new Endpoint in a given project and location.
Parameters
Name
Description
parent
std::string const &
Required. The endpoint's parent.
endpoint
google::cloud::ids::v1::Endpoint const &
Required. The endpoint to create.
endpoint_id
std::string const &
Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
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.ids.v1.Endpoint proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Creates a new Endpoint in a given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
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.ids.v1.CreateEndpointRequest. 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.ids.v1.Endpoint proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Creates a new Endpoint in a given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Creates a new Endpoint in a given project and location.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
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.ids.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
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.ids.v1.DeleteEndpointRequest. 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.ids.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
[[["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 documentation outlines the IDSClient class and its various methods for interacting with the IDS Service, including a history of versions from 2.11.0 up to the current release candidate version 2.37.0-rc.\u003c/p\u003e\n"],["\u003cp\u003eThe IDSClient class uses copy and move operations to efficiently manage resources, where creating new instances is expensive due to establishing new service connections, while copies are efficient and share underlying resources.\u003c/p\u003e\n"],["\u003cp\u003eConcurrent access to different IDSClient instances is supported, but concurrent access to the same instance is not, therefore the use of copying the instance is suggested when needing to use it across multiple threads.\u003c/p\u003e\n"],["\u003cp\u003eThe IDSClient class provides methods to list, get, create, and delete Endpoints within a project and location, with each operation having the option to override the class level options, and most operations using Long Running Operations (LRO) or NoAwaitTag to handle asynchronous tasks.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListEndpoints\u003c/code\u003e, \u003ccode\u003eGetEndpoint\u003c/code\u003e, \u003ccode\u003eCreateEndpoint\u003c/code\u003e and \u003ccode\u003eDeleteEndpoint\u003c/code\u003e methods can be called either by passing each necessary parameter individually, or by passing an instance of their respective \u003ccode\u003eRequest\u003c/code\u003e class in order to bundle the parameters together.\u003c/p\u003e\n"]]],[],null,["# Class IDSClient (2.36.0)\n\nVersion 2.36.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/ids/latest/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.41.0](/cpp/docs/reference/ids/2.41.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.40.0](/cpp/docs/reference/ids/2.40.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.39.0](/cpp/docs/reference/ids/2.39.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.38.0](/cpp/docs/reference/ids/2.38.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.37.0](/cpp/docs/reference/ids/2.37.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.36.0](/cpp/docs/reference/ids/2.36.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.35.0](/cpp/docs/reference/ids/2.35.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.34.0](/cpp/docs/reference/ids/2.34.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.33.0](/cpp/docs/reference/ids/2.33.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.32.0](/cpp/docs/reference/ids/2.32.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.31.0](/cpp/docs/reference/ids/2.31.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.30.0](/cpp/docs/reference/ids/2.30.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.29.0](/cpp/docs/reference/ids/2.29.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.28.0](/cpp/docs/reference/ids/2.28.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.27.0](/cpp/docs/reference/ids/2.27.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.26.0](/cpp/docs/reference/ids/2.26.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.25.1](/cpp/docs/reference/ids/2.25.1/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.24.0](/cpp/docs/reference/ids/2.24.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.23.0](/cpp/docs/reference/ids/2.23.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.22.1](/cpp/docs/reference/ids/2.22.1/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.21.0](/cpp/docs/reference/ids/2.21.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.20.0](/cpp/docs/reference/ids/2.20.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.19.0](/cpp/docs/reference/ids/2.19.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.18.0](/cpp/docs/reference/ids/2.18.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.17.0](/cpp/docs/reference/ids/2.17.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.16.0](/cpp/docs/reference/ids/2.16.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.15.1](/cpp/docs/reference/ids/2.15.1/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.14.0](/cpp/docs/reference/ids/2.14.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.13.0](/cpp/docs/reference/ids/2.13.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.12.0](/cpp/docs/reference/ids/2.12.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient)\n- [2.11.0](/cpp/docs/reference/ids/2.11.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient) \nThe IDS Service. \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### IDSClient(IDSClient const \\&)\n\nCopy and move support\n\n### IDSClient(IDSClient \\&\\&)\n\nCopy and move support\n\n### IDSClient(std::shared_ptr\\\u003c IDSConnection \\\u003e, Options)\n\nOperators\n---------\n\n### operator=(IDSClient const \\&)\n\nCopy and move support\n\n### operator=(IDSClient \\&\\&)\n\nCopy and move support\n\nFunctions\n---------\n\n### ListEndpoints(std::string const \\&, Options)\n\nLists Endpoints in a given project and location.\n\n### ListEndpoints(google::cloud::ids::v1::ListEndpointsRequest, Options)\n\nLists Endpoints in a given project and location.\n\n### GetEndpoint(std::string const \\&, Options)\n\nGets details of a single Endpoint.\n\n### GetEndpoint(google::cloud::ids::v1::GetEndpointRequest const \\&, Options)\n\nGets details of a single Endpoint.\n\n### CreateEndpoint(std::string const \\&, google::cloud::ids::v1::Endpoint const \\&, std::string const \\&, Options)\n\nCreates a new Endpoint in a given project and location.\n\n### CreateEndpoint(NoAwaitTag, std::string const \\&, google::cloud::ids::v1::Endpoint const \\&, std::string const \\&, Options)\n\nCreates a new Endpoint in a given project and location. \nSpecifying the [`NoAwaitTag`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1NoAwaitTag.html) immediately returns the \\[`google::longrunning::Operation`\\] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.\n\n### CreateEndpoint(google::cloud::ids::v1::CreateEndpointRequest const \\&, Options)\n\nCreates a new Endpoint in a given project and location.\n\n### CreateEndpoint(NoAwaitTag, google::cloud::ids::v1::CreateEndpointRequest const \\&, Options)\n\nCreates a new Endpoint in a given project and location. \nSpecifying the [`NoAwaitTag`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1NoAwaitTag.html) immediately returns the \\[`google::longrunning::Operation`\\] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.\n\n### CreateEndpoint(google::longrunning::Operation const \\&, Options)\n\nCreates a new Endpoint in a given project and location. \nThis method accepts a `google::longrunning::Operation` that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.\n\n### DeleteEndpoint(std::string const \\&, Options)\n\nDeletes a single Endpoint.\n\n### DeleteEndpoint(NoAwaitTag, std::string const \\&, Options)\n\nDeletes a single Endpoint. \nSpecifying the [`NoAwaitTag`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1NoAwaitTag.html) immediately returns the \\[`google::longrunning::Operation`\\] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.\n\n### DeleteEndpoint(google::cloud::ids::v1::DeleteEndpointRequest const \\&, Options)\n\nDeletes a single Endpoint.\n\n### DeleteEndpoint(NoAwaitTag, google::cloud::ids::v1::DeleteEndpointRequest const \\&, Options)\n\nDeletes a single Endpoint. \nSpecifying the [`NoAwaitTag`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1NoAwaitTag.html) immediately returns the \\[`google::longrunning::Operation`\\] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.\n\n### DeleteEndpoint(google::longrunning::Operation const \\&, Options)\n\nDeletes a single Endpoint. \nThis method accepts a `google::longrunning::Operation` that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background."]]
