Class RegistrationServiceClient (2.12.0)

Service Directory API for registering services.

It defines the following resource model:

  • The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.
  • Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.
  • Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.
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

RegistrationServiceClient(RegistrationServiceClient const &)

Copy and move support

Parameter
Name Description
RegistrationServiceClient const &

RegistrationServiceClient(RegistrationServiceClient &&)

Copy and move support

Parameter
Name Description
RegistrationServiceClient &&

RegistrationServiceClient(std::shared_ptr< RegistrationServiceConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< RegistrationServiceConnection >
opts Options

Operators

operator=(RegistrationServiceClient const &)

Copy and move support

Parameter
Name Description
RegistrationServiceClient const &
Returns
Type Description
RegistrationServiceClient &

operator=(RegistrationServiceClient &&)

Copy and move support

Parameter
Name Description
RegistrationServiceClient &&
Returns
Type Description
RegistrationServiceClient &

Functions

CreateNamespace(std::string const &, google::cloud::servicedirectory::v1::Namespace const &, std::string const &, Options)

Creates a namespace, and returns the new Namespace.

Parameters
Name Description
parent std::string const &

Required. The resource name of the project and location the namespace will be created in.

namespace_ google::cloud::servicedirectory::v1::Namespace const &

Required. A namespace with initial fields set.

namespace_id std::string const &

Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Namespace >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Namespace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateNamespace(google::cloud::servicedirectory::v1::CreateNamespaceRequest const &, Options)

Creates a namespace, and returns the new Namespace.

Parameters
Name Description
request google::cloud::servicedirectory::v1::CreateNamespaceRequest 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.servicedirectory.v1.CreateNamespaceRequest. 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
StatusOr< google::cloud::servicedirectory::v1::Namespace >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Namespace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListNamespaces(std::string const &, Options)

Lists all namespaces.

Parameters
Name Description
parent std::string const &

Required. The resource name of the project and location whose namespaces we'd like to list.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::servicedirectory::v1::Namespace >

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.servicedirectory.v1.Namespace, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNamespaces(google::cloud::servicedirectory::v1::ListNamespacesRequest, Options)

Lists all namespaces.

Parameters
Name Description
request google::cloud::servicedirectory::v1::ListNamespacesRequest

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.servicedirectory.v1.ListNamespacesRequest. 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::servicedirectory::v1::Namespace >

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.servicedirectory.v1.Namespace, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetNamespace(std::string const &, Options)

Gets a namespace.

Parameters
Name Description
name std::string const &

Required. The name of the namespace to retrieve.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Namespace >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Namespace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNamespace(google::cloud::servicedirectory::v1::GetNamespaceRequest const &, Options)

Gets a namespace.

Parameters
Name Description
request google::cloud::servicedirectory::v1::GetNamespaceRequest 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.servicedirectory.v1.GetNamespaceRequest. 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
StatusOr< google::cloud::servicedirectory::v1::Namespace >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Namespace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateNamespace(google::cloud::servicedirectory::v1::Namespace const &, google::protobuf::FieldMask const &, Options)

Updates a namespace.

Parameters
Name Description
namespace_ google::cloud::servicedirectory::v1::Namespace const &

Required. The updated namespace.

update_mask google::protobuf::FieldMask const &

Required. List of fields to be updated in this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Namespace >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Namespace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateNamespace(google::cloud::servicedirectory::v1::UpdateNamespaceRequest const &, Options)

Updates a namespace.

Parameters
Name Description
request google::cloud::servicedirectory::v1::UpdateNamespaceRequest 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.servicedirectory.v1.UpdateNamespaceRequest. 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
StatusOr< google::cloud::servicedirectory::v1::Namespace >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Namespace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteNamespace(std::string const &, Options)

Deletes a namespace.

This also deletes all services and endpoints in the namespace.

Parameters
Name Description
name std::string const &

Required. The name of the namespace to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteNamespace(google::cloud::servicedirectory::v1::DeleteNamespaceRequest const &, Options)

Deletes a namespace.

This also deletes all services and endpoints in the namespace.

Parameters
Name Description
request google::cloud::servicedirectory::v1::DeleteNamespaceRequest 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.servicedirectory.v1.DeleteNamespaceRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

CreateService(std::string const &, google::cloud::servicedirectory::v1::Service const &, std::string const &, Options)

Creates a service, and returns the new Service.

Parameters
Name Description
parent std::string const &

Required. The resource name of the namespace this service will belong to.

service google::cloud::servicedirectory::v1::Service const &

Required. A service with initial fields set.

service_id std::string const &

Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Service >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateService(google::cloud::servicedirectory::v1::CreateServiceRequest const &, Options)

Creates a service, and returns the new Service.

Parameters
Name Description
request google::cloud::servicedirectory::v1::CreateServiceRequest 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.servicedirectory.v1.CreateServiceRequest. 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
StatusOr< google::cloud::servicedirectory::v1::Service >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListServices(std::string const &, Options)

Lists all services belonging to a namespace.

Parameters
Name Description
parent std::string const &

Required. The resource name of the namespace whose services we'd like to list.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::servicedirectory::v1::Service >

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.servicedirectory.v1.Service, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListServices(google::cloud::servicedirectory::v1::ListServicesRequest, Options)

Lists all services belonging to a namespace.

Parameters
Name Description
request google::cloud::servicedirectory::v1::ListServicesRequest

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.servicedirectory.v1.ListServicesRequest. 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::servicedirectory::v1::Service >

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.servicedirectory.v1.Service, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetService(std::string const &, Options)

Gets a service.

Parameters
Name Description
name std::string const &

Required. The name of the service to get.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Service >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetService(google::cloud::servicedirectory::v1::GetServiceRequest const &, Options)

Gets a service.

Parameters
Name Description
request google::cloud::servicedirectory::v1::GetServiceRequest 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.servicedirectory.v1.GetServiceRequest. 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
StatusOr< google::cloud::servicedirectory::v1::Service >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateService(google::cloud::servicedirectory::v1::Service const &, google::protobuf::FieldMask const &, Options)

Updates a service.

Parameters
Name Description
service google::cloud::servicedirectory::v1::Service const &

Required. The updated service.

update_mask google::protobuf::FieldMask const &

Required. List of fields to be updated in this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Service >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateService(google::cloud::servicedirectory::v1::UpdateServiceRequest const &, Options)

Updates a service.

Parameters
Name Description
request google::cloud::servicedirectory::v1::UpdateServiceRequest 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.servicedirectory.v1.UpdateServiceRequest. 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
StatusOr< google::cloud::servicedirectory::v1::Service >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteService(std::string const &, Options)

Deletes a service.

This also deletes all endpoints associated with the service.

Parameters
Name Description
name std::string const &

Required. The name of the service to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteService(google::cloud::servicedirectory::v1::DeleteServiceRequest const &, Options)

Deletes a service.

This also deletes all endpoints associated with the service.

Parameters
Name Description
request google::cloud::servicedirectory::v1::DeleteServiceRequest 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.servicedirectory.v1.DeleteServiceRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

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

Creates a endpoint, and returns the new Endpoint.

Parameters
Name Description
parent std::string const &

Required. The resource name of the service that this endpoint provides.

endpoint google::cloud::servicedirectory::v1::Endpoint const &

Required. A endpoint with initial fields set.

endpoint_id std::string const &

Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Endpoint >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Endpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Creates a endpoint, and returns the new Endpoint.

Parameters
Name Description
request google::cloud::servicedirectory::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.servicedirectory.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
StatusOr< google::cloud::servicedirectory::v1::Endpoint >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Endpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListEndpoints(std::string const &, Options)

Lists all endpoints.

Parameters
Name Description
parent std::string const &

Required. The resource name of the service whose endpoints we'd like to list.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::servicedirectory::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.servicedirectory.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::servicedirectory::v1::ListEndpointsRequest, Options)

Lists all endpoints.

Parameters
Name Description
request google::cloud::servicedirectory::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.servicedirectory.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::servicedirectory::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.servicedirectory.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 a endpoint.

Parameters
Name Description
name std::string const &

Required. The name of the endpoint to get.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Endpoint >

the result of the RPC. The response message type (google.cloud.servicedirectory.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::servicedirectory::v1::GetEndpointRequest const &, Options)

Gets a endpoint.

Parameters
Name Description
request google::cloud::servicedirectory::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.servicedirectory.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.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Endpoint >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Endpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateEndpoint(google::cloud::servicedirectory::v1::Endpoint const &, google::protobuf::FieldMask const &, Options)

Updates a endpoint.

Parameters
Name Description
endpoint google::cloud::servicedirectory::v1::Endpoint const &

Required. The updated endpoint.

update_mask google::protobuf::FieldMask const &

Required. List of fields to be updated in this request.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::servicedirectory::v1::Endpoint >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Endpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateEndpoint(google::cloud::servicedirectory::v1::UpdateEndpointRequest const &, Options)

Updates a endpoint.

Parameters
Name Description
request google::cloud::servicedirectory::v1::UpdateEndpointRequest 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.servicedirectory.v1.UpdateEndpointRequest. 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
StatusOr< google::cloud::servicedirectory::v1::Endpoint >

the result of the RPC. The response message type (google.cloud.servicedirectory.v1.Endpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteEndpoint(std::string const &, Options)

Deletes a 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
Status

a Status object. If the request failed, the status contains the details of the failure.

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

Deletes a endpoint.

Parameters
Name Description
request google::cloud::servicedirectory::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.servicedirectory.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
Status

a Status object. If the request failed, the status contains the details of the failure.

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the IAM Policy for a resource (namespace or service only).

Parameters
Name Description
request google::iam::v1::GetIamPolicyRequest 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.iam.v1.GetIamPolicyRequest. 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
StatusOr< google::iam::v1::Policy >

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the IAM Policy for a resource (namespace or service only).

Parameters
Name Description
request google::iam::v1::SetIamPolicyRequest 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.iam.v1.SetIamPolicyRequest. 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
StatusOr< google::iam::v1::Policy >

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Tests IAM permissions for a resource (namespace or service only).

Parameters
Name Description
request google::iam::v1::TestIamPermissionsRequest 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.iam.v1.TestIamPermissionsRequest. 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
StatusOr< google::iam::v1::TestIamPermissionsResponse >

the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.