A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://cloud.google.com/cpp/docs/reference/ids/2.36.0/classgoogle_1_1cloud_1_1ids__v1_1_1IDSClient below:

Class IDSClient (2.36.0) | C++ Client Libraries

Skip to main content Class IDSClient (2.36.0)

Stay organized with collections Save and categorize content based on your preferences.

The IDS Service.

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.

Constructors IDSClient(IDSClient const &)

Copy and move support

Parameter Name Description IDSClient const &
IDSClient(IDSClient &&)

Copy and move support

Parameter Name Description IDSClient &&
IDSClient(std::shared_ptr< IDSConnection >, Options) Parameters Name Description connection std::shared_ptr< IDSConnection >
opts Options
Operators operator=(IDSClient const &)

Copy and move support

Parameter Name Description IDSClient const &
Returns Type Description IDSClient & operator=(IDSClient &&)

Copy and move support

Parameter Name Description IDSClient &&
Returns Type Description IDSClient & Functions ListEndpoints(std::string const &, Options)

Lists Endpoints in a given project and location.

Parameters Name Description parent 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 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.

ListEndpoints(google::cloud::ids::v1::ListEndpointsRequest, Options)

Lists Endpoints in a given project and location.

Parameters Name Description request 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 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.

GetEndpoint(google::cloud::ids::v1::GetEndpointRequest const &, Options)

Gets details of a single Endpoint.

Parameters Name Description request 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 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.

Returns Type Description future< 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.

CreateEndpoint(NoAwaitTag, std::string const &, google::cloud::ids::v1::Endpoint const &, std::string const &, Options)

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.

Parameters Name Description NoAwaitTag
parent std::string const &
endpoint google::cloud::ids::v1::Endpoint const &
endpoint_id std::string const &
opts Options
Returns Type Description StatusOr< google::longrunning::Operation > CreateEndpoint(google::cloud::ids::v1::CreateEndpointRequest const &, Options)

Creates a new Endpoint in a given project and location.

Parameters Name Description request 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 Description future< 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.

CreateEndpoint(NoAwaitTag, google::cloud::ids::v1::CreateEndpointRequest const &, Options)

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.

Parameters Name Description NoAwaitTag
request google::cloud::ids::v1::CreateEndpointRequest const &
opts Options
Returns Type Description StatusOr< google::longrunning::Operation > CreateEndpoint(google::longrunning::Operation const &, Options)

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.

Parameters Name Description operation google::longrunning::Operation const &
opts Options
Returns Type Description future< StatusOr< google::cloud::ids::v1::Endpoint > > DeleteEndpoint(std::string const &, Options)

Deletes a single Endpoint.

Parameters Name Description name 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 Description future< 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.

DeleteEndpoint(NoAwaitTag, std::string const &, Options)

Deletes a single Endpoint.

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.

Parameters Name Description NoAwaitTag
name std::string const &
opts Options
Returns Type Description StatusOr< google::longrunning::Operation > DeleteEndpoint(google::cloud::ids::v1::DeleteEndpointRequest const &, Options)

Deletes a single Endpoint.

Parameters Name Description request 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 Description future< 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.

DeleteEndpoint(NoAwaitTag, google::cloud::ids::v1::DeleteEndpointRequest const &, Options)

Deletes a single Endpoint.

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.

Parameters Name Description NoAwaitTag
request google::cloud::ids::v1::DeleteEndpointRequest const &
opts Options
Returns Type Description StatusOr< google::longrunning::Operation > DeleteEndpoint(google::longrunning::Operation const &, Options)

Deletes a single Endpoint.

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.

Parameters Name Description operation google::longrunning::Operation const &
opts Options
Returns Type Description future< StatusOr< google::cloud::ids::v1::OperationMetadata > >

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 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."],["The 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."],["Concurrent 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."],["The 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."],["The `ListEndpoints`, `GetEndpoint`, `CreateEndpoint` and `DeleteEndpoint` methods can be called either by passing each necessary parameter individually, or by passing an instance of their respective `Request` class in order to bundle the parameters together."]]],[]]


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