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 |
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 |
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 |
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: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::ids::v1::Endpoint > | the result of the RPC. The response message type (google.cloud.ids.v1.Endpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::ids::v1::Endpoint > | the result of the RPC. The response message type (google.cloud.ids.v1.Endpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
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 |
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 |
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 |
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 |
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 |
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 |