services

Creates, updates, deletes, gets or lists a services resource.

Overview

Name	services
Type	Resource
Id	google.servicedirectory.services

Fields

Name	Datatype	Description
name	string	Immutable. The resource name for the service in the format projects/*/locations/*/namespaces/*/services/*.
annotations	object	Optional. Annotations for the service. This data can be consumed by service clients. Restrictions: The entire annotations dictionary may contain up to 2000 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected Valid annotation 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 (/). Annotations that fails to meet these requirements are rejected Note: This field is equivalent to the metadata field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.
endpoints	array	Output only. Endpoints associated with this service. Returned on LookupService.ResolveService. Control plane clients should use RegistrationService.ListEndpoints.
uid	string	Output only. The globally unique identifier of the service in the UUID4 format.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, namespacesId, projectsId, servicesId	Gets a service.
list	SELECT	locationsId, namespacesId, projectsId	Lists all services belonging to a namespace.
create	INSERT	locationsId, namespacesId, projectsId	Creates a service, and returns the new service.
delete	DELETE	locationsId, namespacesId, projectsId, servicesId	Deletes a service. This also deletes all endpoints associated with the service.
patch	UPDATE	locationsId, namespacesId, projectsId, servicesId	Updates a service.
resolve	EXEC	locationsId, namespacesId, projectsId, servicesId	Returns a service and its associated endpoints. Resolving a service is not considered an active developer method.

SELECT examples

Lists all services belonging to a namespace.

SELECT
name,
annotations,
endpoints,
uid
FROM google.servicedirectory.services
WHERE locationsId = '{{ locationsId }}'
AND namespacesId = '{{ namespacesId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new services resource.

All Properties

/*+ create */
INSERT INTO google.servicedirectory.services (
locationsId,
namespacesId,
projectsId,
name,
annotations
)
SELECT 
'{{ locationsId }}',
'{{ namespacesId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ annotations }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: annotations
      value: object
    - name: endpoints
      value:
        - - name: name
            value: string
          - name: address
            value: string
          - name: port
            value: integer
          - name: annotations
            value: object
          - name: network
            value: string
          - name: uid
            value: string
    - name: uid
      value: string

UPDATE example

Updates a services resource.

/*+ update */
UPDATE google.servicedirectory.services
SET 
name = '{{ name }}',
annotations = '{{ annotations }}'
WHERE 
locationsId = '{{ locationsId }}'
AND namespacesId = '{{ namespacesId }}'
AND projectsId = '{{ projectsId }}'
AND servicesId = '{{ servicesId }}';

DELETE example

Deletes the specified services resource.

/*+ delete */
DELETE FROM google.servicedirectory.services
WHERE locationsId = '{{ locationsId }}'
AND namespacesId = '{{ namespacesId }}'
AND projectsId = '{{ projectsId }}'
AND servicesId = '{{ servicesId }}';