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
IDSClient const &
IDSClient(IDSClient &&)
Copy and move support
IDSClient &&
IDSClient(std::shared_ptr< IDSConnection >, Options)
connection
std::shared_ptr< IDSConnection >
opts
Options
Operators
operator=(IDSClient const &)
Copy and move support
IDSClient const &
IDSClient &
operator=(IDSClient &&)
Copy and move support
IDSClient &&
IDSClient &
Functions
ListEndpoints(std::string const &, Options)
Lists Endpoints in a given project and location.
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.
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.
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.
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.
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.
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 StatusOr
contains the error details.
GetEndpoint(google::cloud::ids::v1::GetEndpointRequest const &, Options)
Gets details of a single Endpoint.
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.
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 StatusOr
contains the error details.
CreateEndpoint(std::string const &, google::cloud::ids::v1::Endpoint const &, std::string const &, Options)
Creates a new Endpoint in a given project and location.
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.
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.
NoAwaitTag
parent
std::string const &
endpoint
google::cloud::ids::v1::Endpoint const &
endpoint_id
std::string const &
opts
Options
StatusOr< google::longrunning::Operation >
CreateEndpoint(google::cloud::ids::v1::CreateEndpointRequest const &, Options)
Creates a new Endpoint in a given project and location.
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.
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.
NoAwaitTag
request
google::cloud::ids::v1::CreateEndpointRequest const &
opts
Options
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.
operation
google::longrunning::Operation const &
opts
Options
future< StatusOr< google::cloud::ids::v1::Endpoint > >
DeleteEndpoint(std::string const &, Options)
Deletes a single Endpoint.
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.
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.
NoAwaitTag
name
std::string const &
opts
Options
StatusOr< google::longrunning::Operation >
DeleteEndpoint(google::cloud::ids::v1::DeleteEndpointRequest const &, Options)
Deletes a single Endpoint.
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.
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.
NoAwaitTag
request
google::cloud::ids::v1::DeleteEndpointRequest const &
opts
Options
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.
operation
google::longrunning::Operation const &
opts
Options
future< StatusOr< google::cloud::ids::v1::OperationMetadata > >
