Library reference docs
Namespaces
google::cloud::ids_v1
Classes
IDSClient
Functions
IDSLimitedErrorCountRetryPolicy
Structs
Stay organized with collections Save and categorize content based on your preferences.
The IDS Service.
EqualityInstances 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.
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 SafetyConcurrent 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.
Constructors IDSClient(IDSClient const &)Copy and move support
Parameter Name Description
IDSClient const &
Copy and move support
Parameter Name Description
IDSClient &&
connection
std::shared_ptr< IDSConnection >
opts
Options
Copy and move support
Parameter Name Description
IDSClient const &
IDSClient &
operator=(IDSClient &&)
Copy and move support
Parameter Name Description
IDSClient &&
IDSClient &
Functions ListEndpoints(std::string const &, Options)
Lists Endpoints in a given project and location.
Parameters Name Descriptionparent
std::string const &
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 DescriptionStreamRange< 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.
Lists Endpoints in a given project and location.
Parameters Name Descriptionrequest
google::cloud::ids::v1::ListEndpointsRequest
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 DescriptionStreamRange< 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.
Gets details of a single Endpoint.
Parameters Name Descriptionname
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.
GetEndpoint(google::cloud::ids::v1::GetEndpointRequest const &, Options)Gets details of a single Endpoint.
Parameters Name Descriptionrequest
google::cloud::ids::v1::GetEndpointRequest const &
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.
CreateEndpoint(std::string const &, google::cloud::ids::v1::Endpoint const &, std::string const &, Options)Creates a new Endpoint in a given project and location.
Parameters Name Descriptionparent
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.
Returns Type Descriptionfuture< StatusOr< google::cloud::ids::v1::Endpoint > >
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.
Parameters Name Descriptionrequest
google::cloud::ids::v1::CreateEndpointRequest const &
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.
Returns Type Descriptionfuture< StatusOr< google::cloud::ids::v1::Endpoint > >
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.
Deletes a single Endpoint.
Parameters Name Descriptionname
std::string const &
Required. The name of the endpoint to delete.
opts
Options
Optional. Override the class-level options, such as retry and backoff policies.
Returns Type Descriptionfuture< StatusOr< google::cloud::ids::v1::OperationMetadata > >
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.
Deletes a single Endpoint.
Parameters Name Descriptionrequest
google::cloud::ids::v1::DeleteEndpointRequest const &
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.
Returns Type Descriptionfuture< StatusOr< google::cloud::ids::v1::OperationMetadata > >
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["This page details the `IDSClient` class for the IDS Service, offering various methods to manage endpoints and interact with the service."],["The `IDSClient` class supports copy and move operations, ensuring equality between instances created through these methods, and instances with equal `std::shared_ptr\u003cConnection\u003e` objects share resources."],["The service provides functions to list, get, create, and delete endpoints, utilizing `StreamRange` for iterators and `future` for long-running operations."],["Concurrent access to different `IDSClient` instances is safe, while concurrent access to the same instance is not guaranteed to work; copying the instance is recommended for multithreaded use."],["The documentation lists available versions for the class, ranging from 2.11.0 up to the most recent release candidate 2.37.0-rc."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4