REST Resource: projects.locations.namespaces.services

Stay organized with collections Save and categorize content based on your preferences.

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)
    }
  ],
  "createTime": string,
  "updateTime": string
}
Fields
name

string

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

metadata

map (key: string, value: string)

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

Restrictions:

  • The entire metadata dictionary may 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

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" }.

endpoints[]

object (Endpoint)

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

createTime

string (Timestamp format)

Output only. The timestamp when the service was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The timestamp when the service was last updated. Note: endpoints being created/deleted/updated within the service are not considered service updates for the purpose of this timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Methods

create

Creates a service, and returns the new service.

delete

Deletes a service.

get

Gets a service.

getIamPolicy

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

list

Lists all services belonging to a namespace.

patch

Updates a service.

resolve

Returns a service and its associated endpoints.

setIamPolicy

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

testIamPermissions

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