REST Resource:

Resource: Service

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

JSON representation
  "name": string,
  "metadata": {
    string: string,
  "endpoints": [
      object (Endpoint)


Immutable. The resource name for the service in the format projects/*/locations/*/namespaces/*/services/*.


map (key: string, value: string)

Optional. Metadata for the service. This data can be consumed by service clients.


  • The entire metadata dictionary can contain up to 2000 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected
  • Valid metadata keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/). Metadata that fails to meet these requirements are rejected
  • The (*.) and (*.) prefixes are reserved for system metadata managed by Service Directory. If the user tries to write to these keyspaces, those entries are silently ignored by the system

Note: This field is equivalent to the annotations field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.


object (Endpoint)

Output only. Endpoints associated with this service. Returned on LookupService.ResolveService. Control plane clients should use RegistrationService.ListEndpoints.



Creates a service, and returns the new service.


Deletes a service.


Gets a service.


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


Lists all services belonging to a namespace.


Updates a service.


Returns a service and its associated endpoints.


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


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