Package Classes (1.12.0)

Summary of entries of Classes for servicedirectory.

Classes

LookupServiceAsyncClient

Service Directory API for looking up service data at runtime.

LookupServiceClient

Service Directory API for looking up service data at runtime.

RegistrationServiceAsyncClient

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/*.

RegistrationServiceClient

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/*.

ListEndpointsAsyncPager

A pager for iterating through list_endpoints requests.

This class thinly wraps an initial ListEndpointsResponse object, and provides an __aiter__ method to iterate through its endpoints field.

If there are more pages, the __aiter__ method will make additional ListEndpoints requests and continue to iterate through the endpoints field on the corresponding responses.

All the usual ListEndpointsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEndpointsPager

A pager for iterating through list_endpoints requests.

This class thinly wraps an initial ListEndpointsResponse object, and provides an __iter__ method to iterate through its endpoints field.

If there are more pages, the __iter__ method will make additional ListEndpoints requests and continue to iterate through the endpoints field on the corresponding responses.

All the usual ListEndpointsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListNamespacesAsyncPager

A pager for iterating through list_namespaces requests.

This class thinly wraps an initial ListNamespacesResponse object, and provides an __aiter__ method to iterate through its namespaces field.

If there are more pages, the __aiter__ method will make additional ListNamespaces requests and continue to iterate through the namespaces field on the corresponding responses.

All the usual ListNamespacesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListNamespacesPager

A pager for iterating through list_namespaces requests.

This class thinly wraps an initial ListNamespacesResponse object, and provides an __iter__ method to iterate through its namespaces field.

If there are more pages, the __iter__ method will make additional ListNamespaces requests and continue to iterate through the namespaces field on the corresponding responses.

All the usual ListNamespacesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListServicesAsyncPager

A pager for iterating through list_services requests.

This class thinly wraps an initial ListServicesResponse object, and provides an __aiter__ method to iterate through its services field.

If there are more pages, the __aiter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual ListServicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListServicesPager

A pager for iterating through list_services requests.

This class thinly wraps an initial ListServicesResponse object, and provides an __iter__ method to iterate through its services field.

If there are more pages, the __iter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual ListServicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CreateEndpointRequest

The request message for RegistrationService.CreateEndpoint.

CreateNamespaceRequest

The request message for RegistrationService.CreateNamespace.

CreateServiceRequest

The request message for RegistrationService.CreateService.

DeleteEndpointRequest

The request message for RegistrationService.DeleteEndpoint.

DeleteNamespaceRequest

The request message for RegistrationService.DeleteNamespace.

DeleteServiceRequest

The request message for RegistrationService.DeleteService.

Endpoint

An individual endpoint that provides a service. The service must already exist to create an endpoint.

AnnotationsEntry

The abstract base class for a message.

GetEndpointRequest

The request message for RegistrationService.GetEndpoint. This should not be used to lookup endpoints at runtime. Instead, use the resolve method.

GetNamespaceRequest

The request message for RegistrationService.GetNamespace.

GetServiceRequest

The request message for RegistrationService.GetService. This should not be used for looking up a service. Instead, use the resolve method as it contains all endpoints and associated annotations.

ListEndpointsRequest

The request message for RegistrationService.ListEndpoints.

ListEndpointsResponse

The response message for RegistrationService.ListEndpoints.

ListNamespacesRequest

The request message for RegistrationService.ListNamespaces.

ListNamespacesResponse

The response message for RegistrationService.ListNamespaces.

ListServicesRequest

The request message for RegistrationService.ListServices.

ListServicesResponse

The response message for RegistrationService.ListServices.

Namespace

A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services.

LabelsEntry

The abstract base class for a message.

ResolveServiceRequest

The request message for LookupService.ResolveService. Looks up a service by its name, returns the service and its endpoints.

ResolveServiceResponse

The response message for LookupService.ResolveService.

Service

An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.

AnnotationsEntry

The abstract base class for a message.

UpdateEndpointRequest

The request message for RegistrationService.UpdateEndpoint.

UpdateNamespaceRequest

The request message for RegistrationService.UpdateNamespace.

UpdateServiceRequest

The request message for RegistrationService.UpdateService.

LookupServiceAsyncClient

Service Directory API for looking up service data at runtime.

LookupServiceClient

Service Directory API for looking up service data at runtime.

RegistrationServiceAsyncClient

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/*.

RegistrationServiceClient

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/*.

ListEndpointsAsyncPager

A pager for iterating through list_endpoints requests.

This class thinly wraps an initial ListEndpointsResponse object, and provides an __aiter__ method to iterate through its endpoints field.

If there are more pages, the __aiter__ method will make additional ListEndpoints requests and continue to iterate through the endpoints field on the corresponding responses.

All the usual ListEndpointsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEndpointsPager

A pager for iterating through list_endpoints requests.

This class thinly wraps an initial ListEndpointsResponse object, and provides an __iter__ method to iterate through its endpoints field.

If there are more pages, the __iter__ method will make additional ListEndpoints requests and continue to iterate through the endpoints field on the corresponding responses.

All the usual ListEndpointsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListNamespacesAsyncPager

A pager for iterating through list_namespaces requests.

This class thinly wraps an initial ListNamespacesResponse object, and provides an __aiter__ method to iterate through its namespaces field.

If there are more pages, the __aiter__ method will make additional ListNamespaces requests and continue to iterate through the namespaces field on the corresponding responses.

All the usual ListNamespacesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListNamespacesPager

A pager for iterating through list_namespaces requests.

This class thinly wraps an initial ListNamespacesResponse object, and provides an __iter__ method to iterate through its namespaces field.

If there are more pages, the __iter__ method will make additional ListNamespaces requests and continue to iterate through the namespaces field on the corresponding responses.

All the usual ListNamespacesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListServicesAsyncPager

A pager for iterating through list_services requests.

This class thinly wraps an initial ListServicesResponse object, and provides an __aiter__ method to iterate through its services field.

If there are more pages, the __aiter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual ListServicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListServicesPager

A pager for iterating through list_services requests.

This class thinly wraps an initial ListServicesResponse object, and provides an __iter__ method to iterate through its services field.

If there are more pages, the __iter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual ListServicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CreateEndpointRequest

The request message for RegistrationService.CreateEndpoint.

CreateNamespaceRequest

The request message for RegistrationService.CreateNamespace.

CreateServiceRequest

The request message for RegistrationService.CreateService.

DeleteEndpointRequest

The request message for RegistrationService.DeleteEndpoint.

DeleteNamespaceRequest

The request message for RegistrationService.DeleteNamespace.

DeleteServiceRequest

The request message for RegistrationService.DeleteService.

Endpoint

An individual endpoint that provides a service. The service must already exist to create an endpoint.

MetadataEntry

The abstract base class for a message.

GetEndpointRequest

The request message for RegistrationService.GetEndpoint. This should not be used to lookup endpoints at runtime. Instead, use the resolve method.

GetNamespaceRequest

The request message for RegistrationService.GetNamespace.

GetServiceRequest

The request message for RegistrationService.GetService. This should not be used for looking up a service. Instead, use the resolve method as it contains all endpoints and associated metadata.

ListEndpointsRequest

The request message for RegistrationService.ListEndpoints.

ListEndpointsResponse

The response message for RegistrationService.ListEndpoints.

ListNamespacesRequest

The request message for RegistrationService.ListNamespaces.

ListNamespacesResponse

The response message for RegistrationService.ListNamespaces.

ListServicesRequest

The request message for RegistrationService.ListServices.

ListServicesResponse

The response message for RegistrationService.ListServices.

Namespace

A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services.

LabelsEntry

The abstract base class for a message.

ResolveServiceRequest

The request message for LookupService.ResolveService. Looks up a service by its name, returns the service and its endpoints.

ResolveServiceResponse

The response message for LookupService.ResolveService.

Service

An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.

MetadataEntry

The abstract base class for a message.

UpdateEndpointRequest

The request message for RegistrationService.UpdateEndpoint.

UpdateNamespaceRequest

The request message for RegistrationService.UpdateNamespace.

UpdateServiceRequest

The request message for RegistrationService.UpdateService.

Modules

pagers

API documentation for servicedirectory_v1.services.registration_service.pagers module.

pagers

API documentation for servicedirectory_v1beta1.services.registration_service.pagers module.