Service Directory v1 API - Class RegistrationServiceClientImpl (2.3.0)

public sealed class RegistrationServiceClientImpl : RegistrationServiceClient

Reference documentation and code samples for the Service Directory v1 API class RegistrationServiceClientImpl.

RegistrationService client wrapper implementation, for convenient use.

Inheritance

object > RegistrationServiceClient > RegistrationServiceClientImpl

Namespace

Google.Cloud.ServiceDirectory.V1

Assembly

Google.Cloud.ServiceDirectory.V1.dll

Remarks

Service Directory API for registering services. It defines the following resource model:

  • The API has a collection of [Namespace][google.cloud.servicedirectory.v1.Namespace] resources, named projects/*/locations/*/namespaces/*.

  • Each Namespace has a collection of [Service][google.cloud.servicedirectory.v1.Service] resources, named projects/*/locations/*/namespaces/*/services/*.

  • Each Service has a collection of [Endpoint][google.cloud.servicedirectory.v1.Endpoint] resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

Constructors

RegistrationServiceClientImpl(RegistrationServiceClient, RegistrationServiceSettings, ILogger)

public RegistrationServiceClientImpl(RegistrationService.RegistrationServiceClient grpcClient, RegistrationServiceSettings settings, ILogger logger)

Constructs a client wrapper for the RegistrationService service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientRegistrationServiceRegistrationServiceClient

The underlying gRPC client.

settingsRegistrationServiceSettings

The base RegistrationServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override RegistrationService.RegistrationServiceClient GrpcClient { get; }

The underlying gRPC RegistrationService client

Property Value
TypeDescription
RegistrationServiceRegistrationServiceClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

Methods

CreateEndpoint(CreateEndpointRequest, CallSettings)

public override Endpoint CreateEndpoint(CreateEndpointRequest request, CallSettings callSettings = null)

Creates an endpoint, and returns the new endpoint.

Parameters
NameDescription
requestCreateEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Endpoint

The RPC response.

Overrides

CreateEndpointAsync(CreateEndpointRequest, CallSettings)

public override Task<Endpoint> CreateEndpointAsync(CreateEndpointRequest request, CallSettings callSettings = null)

Creates an endpoint, and returns the new endpoint.

Parameters
NameDescription
requestCreateEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEndpoint

A Task containing the RPC response.

Overrides

CreateNamespace(CreateNamespaceRequest, CallSettings)

public override Namespace CreateNamespace(CreateNamespaceRequest request, CallSettings callSettings = null)

Creates a namespace, and returns the new namespace.

Parameters
NameDescription
requestCreateNamespaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Namespace

The RPC response.

Overrides

CreateNamespaceAsync(CreateNamespaceRequest, CallSettings)

public override Task<Namespace> CreateNamespaceAsync(CreateNamespaceRequest request, CallSettings callSettings = null)

Creates a namespace, and returns the new namespace.

Parameters
NameDescription
requestCreateNamespaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskNamespace

A Task containing the RPC response.

Overrides

CreateService(CreateServiceRequest, CallSettings)

public override Service CreateService(CreateServiceRequest request, CallSettings callSettings = null)

Creates a service, and returns the new service.

Parameters
NameDescription
requestCreateServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Service

The RPC response.

Overrides

CreateServiceAsync(CreateServiceRequest, CallSettings)

public override Task<Service> CreateServiceAsync(CreateServiceRequest request, CallSettings callSettings = null)

Creates a service, and returns the new service.

Parameters
NameDescription
requestCreateServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskService

A Task containing the RPC response.

Overrides

DeleteEndpoint(DeleteEndpointRequest, CallSettings)

public override void DeleteEndpoint(DeleteEndpointRequest request, CallSettings callSettings = null)

Deletes an endpoint.

Parameters
NameDescription
requestDeleteEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteEndpointAsync(DeleteEndpointRequest, CallSettings)

public override Task DeleteEndpointAsync(DeleteEndpointRequest request, CallSettings callSettings = null)

Deletes an endpoint.

Parameters
NameDescription
requestDeleteEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteNamespace(DeleteNamespaceRequest, CallSettings)

public override void DeleteNamespace(DeleteNamespaceRequest request, CallSettings callSettings = null)

Deletes a namespace. This also deletes all services and endpoints in the namespace.

Parameters
NameDescription
requestDeleteNamespaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteNamespaceAsync(DeleteNamespaceRequest, CallSettings)

public override Task DeleteNamespaceAsync(DeleteNamespaceRequest request, CallSettings callSettings = null)

Deletes a namespace. This also deletes all services and endpoints in the namespace.

Parameters
NameDescription
requestDeleteNamespaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteService(DeleteServiceRequest, CallSettings)

public override void DeleteService(DeleteServiceRequest request, CallSettings callSettings = null)

Deletes a service. This also deletes all endpoints associated with the service.

Parameters
NameDescription
requestDeleteServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteServiceAsync(DeleteServiceRequest, CallSettings)

public override Task DeleteServiceAsync(DeleteServiceRequest request, CallSettings callSettings = null)

Deletes a service. This also deletes all endpoints associated with the service.

Parameters
NameDescription
requestDeleteServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetEndpoint(GetEndpointRequest, CallSettings)

public override Endpoint GetEndpoint(GetEndpointRequest request, CallSettings callSettings = null)

Gets an endpoint.

Parameters
NameDescription
requestGetEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Endpoint

The RPC response.

Overrides

GetEndpointAsync(GetEndpointRequest, CallSettings)

public override Task<Endpoint> GetEndpointAsync(GetEndpointRequest request, CallSettings callSettings = null)

Gets an endpoint.

Parameters
NameDescription
requestGetEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEndpoint

A Task containing the RPC response.

Overrides

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Overrides

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Overrides

GetNamespace(GetNamespaceRequest, CallSettings)

public override Namespace GetNamespace(GetNamespaceRequest request, CallSettings callSettings = null)

Gets a namespace.

Parameters
NameDescription
requestGetNamespaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Namespace

The RPC response.

Overrides

GetNamespaceAsync(GetNamespaceRequest, CallSettings)

public override Task<Namespace> GetNamespaceAsync(GetNamespaceRequest request, CallSettings callSettings = null)

Gets a namespace.

Parameters
NameDescription
requestGetNamespaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskNamespace

A Task containing the RPC response.

Overrides

GetService(GetServiceRequest, CallSettings)

public override Service GetService(GetServiceRequest request, CallSettings callSettings = null)

Gets a service.

Parameters
NameDescription
requestGetServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Service

The RPC response.

Overrides

GetServiceAsync(GetServiceRequest, CallSettings)

public override Task<Service> GetServiceAsync(GetServiceRequest request, CallSettings callSettings = null)

Gets a service.

Parameters
NameDescription
requestGetServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskService

A Task containing the RPC response.

Overrides

ListEndpoints(ListEndpointsRequest, CallSettings)

public override PagedEnumerable<ListEndpointsResponse, Endpoint> ListEndpoints(ListEndpointsRequest request, CallSettings callSettings = null)

Lists all endpoints.

Parameters
NameDescription
requestListEndpointsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListEndpointsResponseEndpoint

A pageable sequence of Endpoint resources.

Overrides

ListEndpointsAsync(ListEndpointsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEndpointsResponse, Endpoint> ListEndpointsAsync(ListEndpointsRequest request, CallSettings callSettings = null)

Lists all endpoints.

Parameters
NameDescription
requestListEndpointsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListEndpointsResponseEndpoint

A pageable asynchronous sequence of Endpoint resources.

Overrides

ListNamespaces(ListNamespacesRequest, CallSettings)

public override PagedEnumerable<ListNamespacesResponse, Namespace> ListNamespaces(ListNamespacesRequest request, CallSettings callSettings = null)

Lists all namespaces.

Parameters
NameDescription
requestListNamespacesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListNamespacesResponseNamespace

A pageable sequence of Namespace resources.

Overrides

ListNamespacesAsync(ListNamespacesRequest, CallSettings)

public override PagedAsyncEnumerable<ListNamespacesResponse, Namespace> ListNamespacesAsync(ListNamespacesRequest request, CallSettings callSettings = null)

Lists all namespaces.

Parameters
NameDescription
requestListNamespacesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListNamespacesResponseNamespace

A pageable asynchronous sequence of Namespace resources.

Overrides

ListServices(ListServicesRequest, CallSettings)

public override PagedEnumerable<ListServicesResponse, Service> ListServices(ListServicesRequest request, CallSettings callSettings = null)

Lists all services belonging to a namespace.

Parameters
NameDescription
requestListServicesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListServicesResponseService

A pageable sequence of Service resources.

Overrides

ListServicesAsync(ListServicesRequest, CallSettings)

public override PagedAsyncEnumerable<ListServicesResponse, Service> ListServicesAsync(ListServicesRequest request, CallSettings callSettings = null)

Lists all services belonging to a namespace.

Parameters
NameDescription
requestListServicesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListServicesResponseService

A pageable asynchronous sequence of Service resources.

Overrides

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Overrides

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSetIamPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Overrides

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestTestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestIamPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestTestIamPermissionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Overrides

UpdateEndpoint(UpdateEndpointRequest, CallSettings)

public override Endpoint UpdateEndpoint(UpdateEndpointRequest request, CallSettings callSettings = null)

Updates an endpoint.

Parameters
NameDescription
requestUpdateEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Endpoint

The RPC response.

Overrides

UpdateEndpointAsync(UpdateEndpointRequest, CallSettings)

public override Task<Endpoint> UpdateEndpointAsync(UpdateEndpointRequest request, CallSettings callSettings = null)

Updates an endpoint.

Parameters
NameDescription
requestUpdateEndpointRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEndpoint

A Task containing the RPC response.

Overrides

UpdateNamespace(UpdateNamespaceRequest, CallSettings)

public override Namespace UpdateNamespace(UpdateNamespaceRequest request, CallSettings callSettings = null)

Updates a namespace.

Parameters
NameDescription
requestUpdateNamespaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Namespace

The RPC response.

Overrides

UpdateNamespaceAsync(UpdateNamespaceRequest, CallSettings)

public override Task<Namespace> UpdateNamespaceAsync(UpdateNamespaceRequest request, CallSettings callSettings = null)

Updates a namespace.

Parameters
NameDescription
requestUpdateNamespaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskNamespace

A Task containing the RPC response.

Overrides

UpdateService(UpdateServiceRequest, CallSettings)

public override Service UpdateService(UpdateServiceRequest request, CallSettings callSettings = null)

Updates a service.

Parameters
NameDescription
requestUpdateServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Service

The RPC response.

Overrides

UpdateServiceAsync(UpdateServiceRequest, CallSettings)

public override Task<Service> UpdateServiceAsync(UpdateServiceRequest request, CallSettings callSettings = null)

Updates a service.

Parameters
NameDescription
requestUpdateServiceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskService

A Task containing the RPC response.

Overrides